types

package
v1.52.5 Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2025 License: Apache-2.0 Imports: 4 Imported by: 11

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AGAModeForDirectoryEnum added in v1.51.0 

type AGAModeForDirectoryEnum string
const (
	AGAModeForDirectoryEnumEnabledAuto AGAModeForDirectoryEnum = "ENABLED_AUTO"
	AGAModeForDirectoryEnumDisabled    AGAModeForDirectoryEnum = "DISABLED"
)

Enum values for AGAModeForDirectoryEnum

func (AGAModeForDirectoryEnum) Values added in v1.51.0 

func (AGAModeForDirectoryEnum) Values() []AGAModeForDirectoryEnum

Values returns all known values for AGAModeForDirectoryEnum. 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 AGAModeForWorkSpaceEnum added in v1.51.0 

type AGAModeForWorkSpaceEnum string
const (
	AGAModeForWorkSpaceEnumEnabledAuto AGAModeForWorkSpaceEnum = "ENABLED_AUTO"
	AGAModeForWorkSpaceEnumDisabled    AGAModeForWorkSpaceEnum = "DISABLED"
	AGAModeForWorkSpaceEnumInherited   AGAModeForWorkSpaceEnum = "INHERITED"
)

Enum values for AGAModeForWorkSpaceEnum

func (AGAModeForWorkSpaceEnum) Values added in v1.51.0 

func (AGAModeForWorkSpaceEnum) Values() []AGAModeForWorkSpaceEnum

Values returns all known values for AGAModeForWorkSpaceEnum. 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 AGAPreferredProtocolForDirectory added in v1.51.0 

type AGAPreferredProtocolForDirectory string
const (
	AGAPreferredProtocolForDirectoryTcp  AGAPreferredProtocolForDirectory = "TCP"
	AGAPreferredProtocolForDirectoryNone AGAPreferredProtocolForDirectory = "NONE"
)

Enum values for AGAPreferredProtocolForDirectory

func (AGAPreferredProtocolForDirectory) Values added in v1.51.0 

func (AGAPreferredProtocolForDirectory) Values() []AGAPreferredProtocolForDirectory

Values returns all known values for AGAPreferredProtocolForDirectory. 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 AGAPreferredProtocolForWorkSpace added in v1.51.0 

type AGAPreferredProtocolForWorkSpace string
const (
	AGAPreferredProtocolForWorkSpaceTcp       AGAPreferredProtocolForWorkSpace = "TCP"
	AGAPreferredProtocolForWorkSpaceNone      AGAPreferredProtocolForWorkSpace = "NONE"
	AGAPreferredProtocolForWorkSpaceInherited AGAPreferredProtocolForWorkSpace = "INHERITED"
)

Enum values for AGAPreferredProtocolForWorkSpace

func (AGAPreferredProtocolForWorkSpace) Values added in v1.51.0 

func (AGAPreferredProtocolForWorkSpace) Values() []AGAPreferredProtocolForWorkSpace

Values returns all known values for AGAPreferredProtocolForWorkSpace. 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 AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 AccountLink struct {

	// The identifier of the account link.
	AccountLinkId *string

	// The status of the account link.
	AccountLinkStatus AccountLinkStatusEnum

	// The identifier of the source account.
	SourceAccountId *string

	// The identifier of the target account.
	TargetAccountId *string
	// contains filtered or unexported fields
}

Information about about the account link.

type AccountLinkStatusEnum added in v1.39.0 

type AccountLinkStatusEnum string
const (
	AccountLinkStatusEnumLinked                           AccountLinkStatusEnum = "LINKED"
	AccountLinkStatusEnumLinkingFailed                    AccountLinkStatusEnum = "LINKING_FAILED"
	AccountLinkStatusEnumLinkNotFound                     AccountLinkStatusEnum = "LINK_NOT_FOUND"
	AccountLinkStatusEnumPendingAcceptanceByTargetAccount AccountLinkStatusEnum = "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT"
	AccountLinkStatusEnumRejected                         AccountLinkStatusEnum = "REJECTED"
)

Enum values for AccountLinkStatusEnum

func (AccountLinkStatusEnum) Values added in v1.39.0 

func (AccountLinkStatusEnum) Values() []AccountLinkStatusEnum

Values returns all known values for AccountLinkStatusEnum. 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
	// contains filtered or unexported fields
}

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

type ActiveDirectoryConfig added in v1.42.0 

type ActiveDirectoryConfig struct {

	// The name of the domain.
	//
	// This member is required.
	DomainName *string

	// Indicates the secret ARN on the service account.
	//
	// This member is required.
	ServiceAccountSecretArn *string
	// contains filtered or unexported fields
}

Information about the Active Directory config.

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 ApplicationAssociatedResourceType added in v1.31.0 

type ApplicationAssociatedResourceType string
const (
	ApplicationAssociatedResourceTypeWorkspace ApplicationAssociatedResourceType = "WORKSPACE"
	ApplicationAssociatedResourceTypeBundle    ApplicationAssociatedResourceType = "BUNDLE"
	ApplicationAssociatedResourceTypeImage     ApplicationAssociatedResourceType = "IMAGE"
)

Enum values for ApplicationAssociatedResourceType

func (ApplicationAssociatedResourceType) Values added in v1.31.0 

func (ApplicationAssociatedResourceType) Values() []ApplicationAssociatedResourceType

Values returns all known values for ApplicationAssociatedResourceType. 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 ApplicationNotSupportedException added in v1.31.0 

type ApplicationNotSupportedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified application is not supported.

func (*ApplicationNotSupportedException) Error added in v1.31.0 

func (e *ApplicationNotSupportedException) Error() string

func (*ApplicationNotSupportedException) ErrorCode added in v1.31.0 

func (e *ApplicationNotSupportedException) ErrorCode() string

func (*ApplicationNotSupportedException) ErrorFault added in v1.31.0 

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

func (*ApplicationNotSupportedException) ErrorMessage added in v1.31.0 

func (e *ApplicationNotSupportedException) ErrorMessage() string

type ApplicationResourceAssociation added in v1.31.0 

type ApplicationResourceAssociation struct {

	// The identifier of the application.
	ApplicationId *string

	// The identifier of the associated resource.
	AssociatedResourceId *string

	// The resource type of the associated resource.
	AssociatedResourceType ApplicationAssociatedResourceType

	// The time the association was created.
	Created *time.Time

	// The time the association status was last updated.
	LastUpdatedTime *time.Time

	// The status of the application resource association.
	State AssociationState

	// The reason the association deployment failed.
	StateReason *AssociationStateReason
	// contains filtered or unexported fields
}

Describes the association between an application and an application resource.

type ApplicationSettingsRequest added in v1.42.0 

type ApplicationSettingsRequest struct {

	// Enables or disables persistent application settings for users during their pool
	// sessions.
	//
	// This member is required.
	Status ApplicationSettingsStatusEnum

	// The path prefix for the S3 bucket where users’ persistent application settings
	// are stored. You can allow the same persistent application settings to be used
	// across multiple pools by specifying the same settings group for each pool.
	SettingsGroup *string
	// contains filtered or unexported fields
}

The persistent application settings for WorkSpaces Pools users.

type ApplicationSettingsResponse added in v1.42.0 

type ApplicationSettingsResponse struct {

	// Specifies whether persistent application settings are enabled for users during
	// their pool sessions.
	//
	// This member is required.
	Status ApplicationSettingsStatusEnum

	// The S3 bucket where users’ persistent application settings are stored. When
	// persistent application settings are enabled for the first time for an account in
	// an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to
	// the Amazon Web Services account and the Region.
	S3BucketName *string

	// The path prefix for the S3 bucket where users’ persistent application settings
	// are stored.
	SettingsGroup *string
	// contains filtered or unexported fields
}

Describes the persistent application settings for WorkSpaces Pools users.

type ApplicationSettingsStatusEnum added in v1.42.0 

type ApplicationSettingsStatusEnum string
const (
	ApplicationSettingsStatusEnumDisabled ApplicationSettingsStatusEnum = "DISABLED"
	ApplicationSettingsStatusEnumEnabled  ApplicationSettingsStatusEnum = "ENABLED"
)

Enum values for ApplicationSettingsStatusEnum

func (ApplicationSettingsStatusEnum) Values added in v1.42.0 

func (ApplicationSettingsStatusEnum) Values() []ApplicationSettingsStatusEnum

Values returns all known values for ApplicationSettingsStatusEnum. 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 AssociationErrorCode added in v1.31.0 

type AssociationErrorCode string
const (
	AssociationErrorCodeInsufficientDiskspace      AssociationErrorCode = "ValidationError.InsufficientDiskSpace"
	AssociationErrorCodeInsufficientMemory         AssociationErrorCode = "ValidationError.InsufficientMemory"
	AssociationErrorCodeUnsupportedOperatingSystem AssociationErrorCode = "ValidationError.UnsupportedOperatingSystem"
	AssociationErrorCodeInternalServerError        AssociationErrorCode = "DeploymentError.InternalServerError"
	AssociationErrorCodeWorkspaceUnreachable       AssociationErrorCode = "DeploymentError.WorkspaceUnreachable"
)

Enum values for AssociationErrorCode

func (AssociationErrorCode) Values added in v1.31.0 

func (AssociationErrorCode) Values() []AssociationErrorCode

Values returns all known values for AssociationErrorCode. 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 AssociationState added in v1.31.0 

type AssociationState string
const (
	AssociationStatePendingInstall             AssociationState = "PENDING_INSTALL"
	AssociationStatePendingInstallDeployment   AssociationState = "PENDING_INSTALL_DEPLOYMENT"
	AssociationStatePendingUninstall           AssociationState = "PENDING_UNINSTALL"
	AssociationStatePendingUninstallDeployment AssociationState = "PENDING_UNINSTALL_DEPLOYMENT"
	AssociationStateInstalling                 AssociationState = "INSTALLING"
	AssociationStateUninstalling               AssociationState = "UNINSTALLING"
	AssociationStateError                      AssociationState = "ERROR"
	AssociationStateCompleted                  AssociationState = "COMPLETED"
	AssociationStateRemoved                    AssociationState = "REMOVED"
)

Enum values for AssociationState

func (AssociationState) Values added in v1.31.0 

func (AssociationState) Values() []AssociationState

Values returns all known values for AssociationState. 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 AssociationStateReason added in v1.31.0 

type AssociationStateReason struct {

	// The error code of the association deployment failure.
	ErrorCode AssociationErrorCode

	// The error message of the association deployment failure.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Indicates the reason that the association deployment failed, including the error code and error message.

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 AuthenticationType added in v1.42.0 

type AuthenticationType string
const (
	AuthenticationTypeSaml AuthenticationType = "SAML"
)

Enum values for AuthenticationType

func (AuthenticationType) Values added in v1.42.0 

func (AuthenticationType) Values() []AuthenticationType

Values returns all known values for AuthenticationType. 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 BundleAssociatedResourceType added in v1.31.0 

type BundleAssociatedResourceType string
const (
	BundleAssociatedResourceTypeApplication BundleAssociatedResourceType = "APPLICATION"
)

Enum values for BundleAssociatedResourceType

func (BundleAssociatedResourceType) Values added in v1.31.0 

func (BundleAssociatedResourceType) Values() []BundleAssociatedResourceType

Values returns all known values for BundleAssociatedResourceType. 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 BundleResourceAssociation added in v1.31.0 

type BundleResourceAssociation struct {

	// The identifier of the associated resource.
	AssociatedResourceId *string

	// The resource type of the associated resources.
	AssociatedResourceType BundleAssociatedResourceType

	// The identifier of the bundle.
	BundleId *string

	// The time the association is created.
	Created *time.Time

	// The time the association status was last updated.
	LastUpdatedTime *time.Time

	// The status of the bundle resource association.
	State AssociationState

	// The reason the association deployment failed.
	StateReason *AssociationStateReason
	// contains filtered or unexported fields
}

Describes the association between an application and a bundle resource.

type BundleType added in v1.27.0 

type BundleType string
const (
	BundleTypeRegular BundleType = "REGULAR"
	BundleTypeStandby BundleType = "STANDBY"
)

Enum values for BundleType

func (BundleType) Values added in v1.27.0 

func (BundleType) Values() []BundleType

Values returns all known values for BundleType. 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 Capacity added in v1.42.0 

type Capacity struct {

	// The desired number of user sessions for the WorkSpaces in the pool.
	//
	// This member is required.
	DesiredUserSessions *int32
	// contains filtered or unexported fields
}

Describes the user capacity for a pool of WorkSpaces.

type CapacityStatus added in v1.42.0 

type CapacityStatus struct {

	// The number of user sessions currently being used for your pool.
	//
	// This member is required.
	ActiveUserSessions *int32

	// The total number of user sessions that are available for streaming or are
	// currently streaming in your pool.
	//
	// ActualUserSessions = AvailableUserSessions + ActiveUserSessions
	//
	// This member is required.
	ActualUserSessions *int32

	// The number of user sessions currently available for streaming from your pool.
	//
	// AvailableUserSessions = ActualUserSessions - ActiveUserSessions
	//
	// This member is required.
	AvailableUserSessions *int32

	// The total number of sessions slots that are either running or pending. This
	// represents the total number of concurrent streaming sessions your pool can
	// support in a steady state.
	//
	// This member is required.
	DesiredUserSessions *int32
	// contains filtered or unexported fields
}

Describes the capacity status for a pool of WorkSpaces.

type CertificateBasedAuthProperties added in v1.26.0 

type CertificateBasedAuthProperties struct {

	// The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager
	// Private CA resource.
	CertificateAuthorityArn *string

	// The status of the certificate-based authentication properties.
	Status CertificateBasedAuthStatusEnum
	// contains filtered or unexported fields
}

Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.

type CertificateBasedAuthStatusEnum added in v1.26.0 

type CertificateBasedAuthStatusEnum string
const (
	CertificateBasedAuthStatusEnumDisabled CertificateBasedAuthStatusEnum = "DISABLED"
	CertificateBasedAuthStatusEnumEnabled  CertificateBasedAuthStatusEnum = "ENABLED"
)

Enum values for CertificateBasedAuthStatusEnum

func (CertificateBasedAuthStatusEnum) Values added in v1.26.0 

func (CertificateBasedAuthStatusEnum) Values() []CertificateBasedAuthStatusEnum

Values returns all known values for CertificateBasedAuthStatusEnum. 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 ClientDeviceType added in v1.17.0 

type ClientDeviceType string
const (
	ClientDeviceTypeDeviceTypeWindows ClientDeviceType = "DeviceTypeWindows"
	ClientDeviceTypeDeviceTypeOsx     ClientDeviceType = "DeviceTypeOsx"
	ClientDeviceTypeDeviceTypeAndroid ClientDeviceType = "DeviceTypeAndroid"
	ClientDeviceTypeDeviceTypeIos     ClientDeviceType = "DeviceTypeIos"
	ClientDeviceTypeDeviceTypeLinux   ClientDeviceType = "DeviceTypeLinux"
	ClientDeviceTypeDeviceTypeWeb     ClientDeviceType = "DeviceTypeWeb"
)

Enum values for ClientDeviceType

func (ClientDeviceType) Values added in v1.17.0 

func (ClientDeviceType) Values() []ClientDeviceType

Values returns all known values for ClientDeviceType. 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 upload diagnostic log files of Amazon WorkSpaces
	// client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces
	// client. When enabled, the log files will be sent to WorkSpaces automatically and
	// will be applied to all users in the specified directory.
	LogUploadEnabled LogUploadEnum

	// 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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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"
	ComputeGeneralpurpose4xlarge Compute = "GENERALPURPOSE_4XLARGE"
	ComputeGeneralpurpose8xlarge Compute = "GENERALPURPOSE_8XLARGE"
	ComputeGraphicspro           Compute = "GRAPHICSPRO"
	ComputeGraphicsG4dn          Compute = "GRAPHICS_G4DN"
	ComputeGraphicsproG4dn       Compute = "GRAPHICSPRO_G4DN"
)

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 ComputeNotCompatibleException added in v1.31.0 

type ComputeNotCompatibleException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The compute type of the WorkSpace is not compatible with the application.

func (*ComputeNotCompatibleException) Error added in v1.31.0 

func (e *ComputeNotCompatibleException) Error() string

func (*ComputeNotCompatibleException) ErrorCode added in v1.31.0 

func (e *ComputeNotCompatibleException) ErrorCode() string

func (*ComputeNotCompatibleException) ErrorFault added in v1.31.0 

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

func (*ComputeNotCompatibleException) ErrorMessage added in v1.31.0 

func (e *ComputeNotCompatibleException) ErrorMessage() string

type ComputeType 

type ComputeType struct {

	// The compute type.
	Name Compute
	// contains filtered or unexported fields
}

Describes the compute type of the bundle.

type ConflictException added in v1.39.0 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The TargetAccountId is already linked or invited.

func (*ConflictException) Error added in v1.39.0 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode added in v1.39.0 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault added in v1.39.0 

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

func (*ConflictException) ErrorMessage added in v1.39.0 

func (e *ConflictException) ErrorMessage() string

type ConnectClientAddIn added in v1.14.0 

type ConnectClientAddIn struct {

	// The client add-in identifier.
	AddInId *string

	// The name of the client add in.
	Name *string

	// The directory identifier for which the client add-in is configured.
	ResourceId *string

	// The endpoint URL of the client add-in.
	URL *string
	// contains filtered or unexported fields
}

Describes an Amazon Connect client add-in.

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 Amazon Web Services account that owns the connection
	// alias.
	OwnerAccountId *string

	// The current state of the connection alias.
	State ConnectionAliasState
	// contains filtered or unexported fields
}

Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

type ConnectionAliasAssociation added in v0.29.0 

type ConnectionAliasAssociation struct {

	// The identifier of the Amazon Web Services 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
	// contains filtered or unexported fields
}

Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

type ConnectionAliasPermission added in v0.29.0 

type ConnectionAliasPermission struct {

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

	// The identifier of the Amazon Web Services account that the connection alias is
	// shared with.
	//
	// This member is required.
	SharedAccountId *string
	// contains filtered or unexported fields
}

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.

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 DataReplication added in v1.34.0 

type DataReplication string
const (
	DataReplicationNoReplication   DataReplication = "NO_REPLICATION"
	DataReplicationPrimaryAsSource DataReplication = "PRIMARY_AS_SOURCE"
)

Enum values for DataReplication

func (DataReplication) Values added in v1.34.0 

func (DataReplication) Values() []DataReplication

Values returns all known values for DataReplication. 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 DataReplicationSettings added in v1.34.0 

type DataReplicationSettings struct {

	// Indicates whether data replication is enabled, and if enabled, the type of data
	// replication.
	DataReplication DataReplication

	// The date and time at which the last successful snapshot was taken of the
	// primary WorkSpace used for replicating data.
	RecoverySnapshotTime *time.Time
	// contains filtered or unexported fields
}

Describes the data replication settings.

type DedicatedTenancyAccountType added in v1.39.0 

type DedicatedTenancyAccountType string
const (
	DedicatedTenancyAccountTypeSourceAccount DedicatedTenancyAccountType = "SOURCE_ACCOUNT"
	DedicatedTenancyAccountTypeTargetAccount DedicatedTenancyAccountType = "TARGET_ACCOUNT"
)

Enum values for DedicatedTenancyAccountType

func (DedicatedTenancyAccountType) Values added in v1.39.0 

func (DedicatedTenancyAccountType) Values() []DedicatedTenancyAccountType

Values returns all known values for DedicatedTenancyAccountType. 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 DefaultClientBrandingAttributes added in v1.17.0 

type DefaultClientBrandingAttributes struct {

	// The forgotten password link. This is the web address that users can go to if
	// they forget the password for their WorkSpace.
	ForgotPasswordLink *string

	// The login message. Specified as a key value pair, in which the key is a locale
	// and the value is the localized message for that locale. The only key supported
	// is en_US . The HTML tags supported include the following: a, b, blockquote, br,
	// cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike,
	// strong, sub, sup, u, ul .
	LoginMessage map[string]string

	// The logo. The only image format accepted is a binary data object that is
	// converted from a .png file.
	LogoUrl *string

	// The support email. The company's customer support email address.
	//
	//   - In each platform type, the SupportEmail and SupportLink parameters are
	//   mutually exclusive. You can specify one parameter for each platform type, but
	//   not both.
	//
	//   - The default email is workspaces-feedback@amazon.com .
	SupportEmail *string

	// The support link. The link for the company's customer support page for their
	// WorkSpace.
	//
	//   - In each platform type, the SupportEmail and SupportLink parameters are
	//   mutually exclusive.You can specify one parameter for each platform type, but not
	//   both.
	//
	//   - The default support link is workspaces-feedback@amazon.com .
	SupportLink *string
	// contains filtered or unexported fields
}

Returns default client branding attributes that were imported. These attributes display on the client login screen.

Client branding attributes are public facing. Ensure that you don't include sensitive information.

type DefaultImportClientBrandingAttributes added in v1.17.0 

type DefaultImportClientBrandingAttributes struct {

	// The forgotten password link. This is the web address that users can go to if
	// they forget the password for their WorkSpace.
	ForgotPasswordLink *string

	// The login message. Specified as a key value pair, in which the key is a locale
	// and the value is the localized message for that locale. The only key supported
	// is en_US . The HTML tags supported include the following: a, b, blockquote, br,
	// cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike,
	// strong, sub, sup, u, ul .
	LoginMessage map[string]string

	// converted from a .png file.
	Logo []byte

	// The support email. The company's customer support email address.
	//
	//   - In each platform type, the SupportEmail and SupportLink parameters are
	//   mutually exclusive. You can specify one parameter for each platform type, but
	//   not both.
	//
	//   - The default email is workspaces-feedback@amazon.com .
	SupportEmail *string

	// The support link. The link for the company's customer support page for their
	// WorkSpace.
	//
	//   - In each platform type, the SupportEmail and SupportLink parameters are
	//   mutually exclusive. You can specify one parameter for each platform type, but
	//   not both.
	//
	//   - The default support link is workspaces-feedback@amazon.com .
	SupportLink *string
	// contains filtered or unexported fields
}

The default client branding attributes to be imported. These attributes display on the client login screen.

Client branding attributes are public facing. Ensure that you do not include sensitive information.

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

	// Indicates the IAM role ARN of the instance.
	InstanceIamRoleArn *string

	// Specifies whether WorkSpace users are local administrators on their WorkSpaces.
	UserEnabledAsLocalAdministrator *bool
	// contains filtered or unexported fields
}

Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

type DeletableCertificateBasedAuthProperty added in v1.26.0 

type DeletableCertificateBasedAuthProperty string
const (
	DeletableCertificateBasedAuthPropertyCertificateBasedAuthPropertiesCertificateAuthorityArn DeletableCertificateBasedAuthProperty = "CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN"
)

Enum values for DeletableCertificateBasedAuthProperty

func (DeletableCertificateBasedAuthProperty) Values added in v1.26.0 

func (DeletableCertificateBasedAuthProperty) Values() []DeletableCertificateBasedAuthProperty

Values returns all known values for DeletableCertificateBasedAuthProperty. 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 DeletableSamlProperty added in v1.22.0 

type DeletableSamlProperty string
const (
	DeletableSamlPropertySamlPropertiesUserAccessUrl           DeletableSamlProperty = "SAML_PROPERTIES_USER_ACCESS_URL"
	DeletableSamlPropertySamlPropertiesRelayStateParameterName DeletableSamlProperty = "SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME"
)

Enum values for DeletableSamlProperty

func (DeletableSamlProperty) Values added in v1.22.0 

func (DeletableSamlProperty) Values() []DeletableSamlProperty

Values returns all known values for DeletableSamlProperty. 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 DescribeWorkspaceDirectoriesFilter added in v1.46.0 

type DescribeWorkspaceDirectoriesFilter struct {

	// The name of the WorkSpaces to filter.
	//
	// This member is required.
	Name DescribeWorkspaceDirectoriesFilterName

	// The values for filtering WorkSpaces
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Describes the filter conditions for the WorkSpaces to return.

type DescribeWorkspaceDirectoriesFilterName added in v1.46.0 

type DescribeWorkspaceDirectoriesFilterName string
const (
	DescribeWorkspaceDirectoriesFilterNameUserIdentityType DescribeWorkspaceDirectoriesFilterName = "USER_IDENTITY_TYPE"
	DescribeWorkspaceDirectoriesFilterNameWorkspaceType    DescribeWorkspaceDirectoriesFilterName = "WORKSPACE_TYPE"
)

Enum values for DescribeWorkspaceDirectoriesFilterName

func (DescribeWorkspaceDirectoriesFilterName) Values added in v1.46.0 

func (DescribeWorkspaceDirectoriesFilterName) Values() []DescribeWorkspaceDirectoriesFilterName

Values returns all known values for DescribeWorkspaceDirectoriesFilterName. 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 DescribeWorkspacesPoolsFilter added in v1.42.0 

type DescribeWorkspacesPoolsFilter struct {

	// The name of the pool to filter.
	//
	// This member is required.
	Name DescribeWorkspacesPoolsFilterName

	// The operator values for filtering WorkSpaces Pools.
	//
	// This member is required.
	Operator DescribeWorkspacesPoolsFilterOperator

	// The values for filtering WorkSpaces Pools.
	//
	// This member is required.
	Values []string
	// contains filtered or unexported fields
}

Describes the filter conditions for WorkSpaces Pools to return.

type DescribeWorkspacesPoolsFilterName added in v1.42.0 

type DescribeWorkspacesPoolsFilterName string
const (
	DescribeWorkspacesPoolsFilterNamePoolname DescribeWorkspacesPoolsFilterName = "PoolName"
)

Enum values for DescribeWorkspacesPoolsFilterName

func (DescribeWorkspacesPoolsFilterName) Values added in v1.42.0 

func (DescribeWorkspacesPoolsFilterName) Values() []DescribeWorkspacesPoolsFilterName

Values returns all known values for DescribeWorkspacesPoolsFilterName. 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 DescribeWorkspacesPoolsFilterOperator added in v1.42.0 

type DescribeWorkspacesPoolsFilterOperator string
const (
	DescribeWorkspacesPoolsFilterOperatorEquals      DescribeWorkspacesPoolsFilterOperator = "EQUALS"
	DescribeWorkspacesPoolsFilterOperatorNotequals   DescribeWorkspacesPoolsFilterOperator = "NOTEQUALS"
	DescribeWorkspacesPoolsFilterOperatorContains    DescribeWorkspacesPoolsFilterOperator = "CONTAINS"
	DescribeWorkspacesPoolsFilterOperatorNotcontains DescribeWorkspacesPoolsFilterOperator = "NOTCONTAINS"
)

Enum values for DescribeWorkspacesPoolsFilterOperator

func (DescribeWorkspacesPoolsFilterOperator) Values added in v1.42.0 

func (DescribeWorkspacesPoolsFilterOperator) Values() []DescribeWorkspacesPoolsFilterOperator

Values returns all known values for DescribeWorkspacesPoolsFilterOperator. 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 ErrorDetails added in v1.30.0 

type ErrorDetails struct {

	// Indicates the error code returned.
	ErrorCode WorkspaceImageErrorDetailCode

	// The text of the error message related the error code.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.

type FailedCreateStandbyWorkspacesRequest added in v1.27.0 

type FailedCreateStandbyWorkspacesRequest struct {

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

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

	// Information about the standby WorkSpace that could not be created.
	StandbyWorkspaceRequest *StandbyWorkspace
	// contains filtered or unexported fields
}

Describes the standby WorkSpace that could not be created.

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
	// contains filtered or unexported fields
}

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
	// contains filtered or unexported fields
}

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

type GlobalAcceleratorForDirectory added in v1.51.0 

type GlobalAcceleratorForDirectory struct {

	// Indicates if Global Accelerator for directory is enabled or disabled.
	//
	// This member is required.
	Mode AGAModeForDirectoryEnum

	// Indicates the preferred protocol for Global Accelerator.
	PreferredProtocol AGAPreferredProtocolForDirectory
	// contains filtered or unexported fields
}

Describes the Global Accelerator for directory

type GlobalAcceleratorForWorkSpace added in v1.51.0 

type GlobalAcceleratorForWorkSpace struct {

	// Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the
	// same mode as the associated directory.
	//
	// This member is required.
	Mode AGAModeForWorkSpaceEnum

	// Indicates the preferred protocol for Global Accelerator.
	PreferredProtocol AGAPreferredProtocolForWorkSpace
	// contains filtered or unexported fields
}

Describes the Global Accelerator for WorkSpaces.

type IDCConfig added in v1.46.0 

type IDCConfig struct {

	// The Amazon Resource Name (ARN) of the application.
	ApplicationArn *string

	// The Amazon Resource Name (ARN) of the identity center instance.
	InstanceArn *string
	// contains filtered or unexported fields
}

Specifies the configurations of the identity center.

type ImageAssociatedResourceType added in v1.31.0 

type ImageAssociatedResourceType string
const (
	ImageAssociatedResourceTypeApplication ImageAssociatedResourceType = "APPLICATION"
)

Enum values for ImageAssociatedResourceType

func (ImageAssociatedResourceType) Values added in v1.31.0 

func (ImageAssociatedResourceType) Values() []ImageAssociatedResourceType

Values returns all known values for ImageAssociatedResourceType. 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 ImagePermission 

type ImagePermission struct {

	// The identifier of the Amazon Web Services account that an image has been shared
	// with.
	SharedAccountId *string
	// contains filtered or unexported fields
}

Describes the Amazon Web Services 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.

type ImageResourceAssociation added in v1.31.0 

type ImageResourceAssociation struct {

	// The identifier of the associated resource.
	AssociatedResourceId *string

	// The resource type of the associated resources.
	AssociatedResourceType ImageAssociatedResourceType

	// The time the association is created.
	Created *time.Time

	// The identifier of the image.
	ImageId *string

	// The time the association status was last updated.
	LastUpdatedTime *time.Time

	// The status of the image resource association.
	State AssociationState

	// The reason the association deployment failed.
	StateReason *AssociationStateReason
	// contains filtered or unexported fields
}

Describes the association between an application and an image resource.

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 IncompatibleApplicationsException added in v1.31.0 

type IncompatibleApplicationsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified application is not compatible with the resource.

func (*IncompatibleApplicationsException) Error added in v1.31.0 

func (e *IncompatibleApplicationsException) Error() string

func (*IncompatibleApplicationsException) ErrorCode added in v1.31.0 

func (e *IncompatibleApplicationsException) ErrorCode() string

func (*IncompatibleApplicationsException) ErrorFault added in v1.31.0 

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

func (*IncompatibleApplicationsException) ErrorMessage added in v1.31.0 

func (e *IncompatibleApplicationsException) ErrorMessage() string

type InternalServerException added in v1.39.0 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Unexpected server error occured.

func (*InternalServerException) Error added in v1.39.0 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode added in v1.39.0 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault added in v1.39.0 

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

func (*InternalServerException) ErrorMessage added in v1.39.0 

func (e *InternalServerException) ErrorMessage() string

type InvalidParameterValuesException 

type InvalidParameterValuesException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 IosClientBrandingAttributes added in v1.17.0 

type IosClientBrandingAttributes struct {

	// The forgotten password link. This is the web address that users can go to if
	// they forget the password for their WorkSpace.
	ForgotPasswordLink *string

	// The login message. Specified as a key value pair, in which the key is a locale
	// and the value is the localized message for that locale. The only key supported
	// is en_US . The HTML tags supported include the following: a, b, blockquote, br,
	// cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike,
	// strong, sub, sup, u, ul .
	LoginMessage map[string]string

	// The @2x version of the logo. This is the higher resolution display that offers
	// a scale factor of 2.0 (or @2x). The only image format accepted is a binary data
	// object that is converted from a .png file.
	//
	// For more information about iOS image size and resolution, see [Image Size and Resolution] in the Apple
	// Human Interface Guidelines.
	//
	// [Image Size and Resolution]: https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/
	Logo2xUrl *string

	// The @3x version of the logo. This is the higher resolution display that offers
	// a scale factor of 3.0 (or @3x).The only image format accepted is a binary data
	// object that is converted from a .png file.
	//
	// For more information about iOS image size and resolution, see [Image Size and Resolution] in the Apple
	// Human Interface Guidelines.
	//
	// [Image Size and Resolution]: https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/
	Logo3xUrl *string

	// The logo. This is the standard-resolution display that has a 1:1 pixel density
	// (or @1x), where one pixel is equal to one point. The only image format accepted
	// is a binary data object that is converted from a .png file.
	LogoUrl *string

	// The support email. The company's customer support email address.
	//
	//   - In each platform type, the SupportEmail and SupportLink parameters are
	//   mutually exclusive. You can specify one parameter for each platform type, but
	//   not both.
	//
	//   - The default email is workspaces-feedback@amazon.com .
	SupportEmail *string

	// The support link. The link for the company's customer support page for their
	// WorkSpace.
	//
	//   - In each platform type, the SupportEmail and SupportLink parameters are
	//   mutually exclusive. You can specify one parameter for each platform type, but
	//   not both.
	//
	//   - The default support link is workspaces-feedback@amazon.com .
	SupportLink *string
	// contains filtered or unexported fields
}

The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.

Client branding attributes are public facing. Ensure you do not include sensitive information.

type IosImportClientBrandingAttributes added in v1.17.0 

type IosImportClientBrandingAttributes struct {

	// The forgotten password link. This is the web address that users can go to if
	// they forget the password for their WorkSpace.
	ForgotPasswordLink *string

	// The login message. Specified as a key value pair, in which the key is a locale
	// and the value is the localized message for that locale. The only key supported
	// is en_US . The HTML tags supported include the following: a, b, blockquote, br,
	// cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike,
	// strong, sub, sup, u, ul .
	LoginMessage map[string]string

	// (or @1x), where one pixel is equal to one point. The only image format accepted
	// is a binary data object that is converted from a .png file.
	Logo []byte

	// The @2x version of the logo. This is the higher resolution display that offers
	// a scale factor of 2.0 (or @2x). The only image format accepted is a binary data
	// object that is converted from a .png file.
	//
	// For more information about iOS image size and resolution, see [Image Size and Resolution] in the Apple
	// Human Interface Guidelines.
	//
	// [Image Size and Resolution]: https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/
	Logo2x []byte

	// The @3x version of the logo. This is the higher resolution display that offers
	// a scale factor of 3.0 (or @3x). The only image format accepted is a binary data
	// object that is converted from a .png file.
	//
	// For more information about iOS image size and resolution, see [Image Size and Resolution] in the Apple
	// Human Interface Guidelines.
	//
	// [Image Size and Resolution]: https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/
	Logo3x []byte

	// The support email. The company's customer support email address.
	//
	//   - In each platform type, the SupportEmail and SupportLink parameters are
	//   mutually exclusive. You can specify one parameter for each platform type, but
	//   not both.
	//
	//   - The default email is workspaces-feedback@amazon.com .
	SupportEmail *string

	// The support link. The link for the company's customer support page for their
	// WorkSpace.
	//
	//   - In each platform type, the SupportEmail and SupportLink parameters are
	//   mutually exclusive. You can specify one parameter for each platform type, but
	//   not both.
	//
	//   - The default support link is workspaces-feedback@amazon.com .
	SupportLink *string
	// contains filtered or unexported fields
}

The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.

Client branding attributes are public facing. Ensure you do not include sensitive information.

type IpRuleItem 

type IpRuleItem struct {

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

	// The description.
	RuleDesc *string
	// contains filtered or unexported fields
}

Describes a rule for an IP access control group.

type LogUploadEnum added in v1.23.0 

type LogUploadEnum string
const (
	LogUploadEnumEnabled  LogUploadEnum = "ENABLED"
	LogUploadEnumDisabled LogUploadEnum = "DISABLED"
)

Enum values for LogUploadEnum

func (LogUploadEnum) Values added in v1.23.0 

func (LogUploadEnum) Values() []LogUploadEnum

Values returns all known values for LogUploadEnum. 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 MicrosoftEntraConfig added in v1.46.0 

type MicrosoftEntraConfig struct {

	// The Amazon Resource Name (ARN) of the application config.
	ApplicationConfigSecretArn *string

	// The identifier of the tenant.
	TenantId *string
	// contains filtered or unexported fields
}

Specifies the configurations of the Microsoft Entra.

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
	// contains filtered or unexported fields
}

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 NetworkAccessConfiguration added in v1.42.0 

type NetworkAccessConfiguration struct {

	// The resource identifier of the elastic network interface that is attached to
	// instances in your VPC. All network interfaces have the eni-xxxxxxxx resource
	// identifier.
	EniId *string

	// The private IP address of the elastic network interface that is attached to
	// instances in your VPC.
	EniPrivateIpAddress *string
	// contains filtered or unexported fields
}

Describes the network details of a WorkSpaces Pool.

type OperatingSystem 

type OperatingSystem struct {

	// The operating system.
	Type OperatingSystemType
	// contains filtered or unexported fields
}

The operating system that the image is running.

type OperatingSystemName added in v1.31.0 

type OperatingSystemName string
const (
	OperatingSystemNameAmazonLinux2      OperatingSystemName = "AMAZON_LINUX_2"
	OperatingSystemNameUbuntu1804        OperatingSystemName = "UBUNTU_18_04"
	OperatingSystemNameUbuntu2004        OperatingSystemName = "UBUNTU_20_04"
	OperatingSystemNameUbuntu2204        OperatingSystemName = "UBUNTU_22_04"
	OperatingSystemNameUnknown           OperatingSystemName = "UNKNOWN"
	OperatingSystemNameWindows10         OperatingSystemName = "WINDOWS_10"
	OperatingSystemNameWindows11         OperatingSystemName = "WINDOWS_11"
	OperatingSystemNameWindows7          OperatingSystemName = "WINDOWS_7"
	OperatingSystemNameWindowsServer2016 OperatingSystemName = "WINDOWS_SERVER_2016"
	OperatingSystemNameWindowsServer2019 OperatingSystemName = "WINDOWS_SERVER_2019"
	OperatingSystemNameWindowsServer2022 OperatingSystemName = "WINDOWS_SERVER_2022"
	OperatingSystemNameRhel8             OperatingSystemName = "RHEL_8"
	OperatingSystemNameRocky8            OperatingSystemName = "ROCKY_8"
)

Enum values for OperatingSystemName

func (OperatingSystemName) Values added in v1.31.0 

func (OperatingSystemName) Values() []OperatingSystemName

Values returns all known values for OperatingSystemName. 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 OperatingSystemNotCompatibleException added in v1.31.0 

type OperatingSystemNotCompatibleException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operating system of the WorkSpace is not compatible with the application.

func (*OperatingSystemNotCompatibleException) Error added in v1.31.0 

func (e *OperatingSystemNotCompatibleException) Error() string

func (*OperatingSystemNotCompatibleException) ErrorCode added in v1.31.0 

func (e *OperatingSystemNotCompatibleException) ErrorCode() string

func (*OperatingSystemNotCompatibleException) ErrorFault added in v1.31.0 

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

func (*OperatingSystemNotCompatibleException) ErrorMessage added in v1.31.0 

func (e *OperatingSystemNotCompatibleException) ErrorMessage() string

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	Reason *string
	// contains filtered or unexported fields
}

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 PendingCreateStandbyWorkspacesRequest added in v1.27.0 

type PendingCreateStandbyWorkspacesRequest struct {

	// The identifier of the directory for the standby WorkSpace.
	DirectoryId *string

	// The operational state of the standby WorkSpace.
	State WorkspaceState

	// Describes the standby WorkSpace that was 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.
	//
	// [DescribeWorkspaces]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html
	UserName *string

	// The identifier of the standby WorkSpace.
	WorkspaceId *string
	// contains filtered or unexported fields
}

Information about the standby WorkSpace.

type Protocol added in v1.25.0 

type Protocol string
const (
	ProtocolPcoip Protocol = "PCOIP"
	ProtocolWsp   Protocol = "WSP"
)

Enum values for Protocol

func (Protocol) Values added in v1.25.0 

func (Protocol) Values() []Protocol

Values returns all known values for Protocol. 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 RebootRequest 

type RebootRequest struct {

	// The identifier of the WorkSpace.
	//
	// This member is required.
	WorkspaceId *string
	// contains filtered or unexported fields
}

Describes the information used to reboot a WorkSpace.

type RebuildRequest 

type RebuildRequest struct {

	// The identifier of the WorkSpace.
	//
	// This member is required.
	WorkspaceId *string
	// contains filtered or unexported fields
}

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 RelatedWorkspaceProperties added in v1.27.0 

type RelatedWorkspaceProperties struct {

	// The Region of the related WorkSpace.
	Region *string

	// Indicates the state of the WorkSpace.
	State WorkspaceState

	// Indicates the type of WorkSpace.
	Type StandbyWorkspaceRelationshipType

	// The identifier of the related WorkSpace.
	WorkspaceId *string
	// contains filtered or unexported fields
}

Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 ResourceInUseException added in v1.31.0 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId *string
	// contains filtered or unexported fields
}

The specified resource is currently in use.

func (*ResourceInUseException) Error added in v1.31.0 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode added in v1.31.0 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault added in v1.31.0 

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

func (*ResourceInUseException) ErrorMessage added in v1.31.0 

func (e *ResourceInUseException) ErrorMessage() string

type ResourceLimitExceededException 

type ResourceLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	ResourceId *string
	// contains filtered or unexported fields
}

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

	ErrorCodeOverride *string

	ResourceId *string
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	Capacity *string
	// contains filtered or unexported fields
}

Describes the root volume for a WorkSpace bundle.

type RunningMode 

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

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 SamlProperties added in v1.22.0 

type SamlProperties struct {

	// The relay state parameter name supported by the SAML 2.0 identity provider
	// (IdP). When the end user is redirected to the user access URL from the
	// WorkSpaces client application, this relay state parameter name is appended as a
	// query parameter to the URL along with the relay state endpoint to return the
	// user to the client application session.
	//
	// To use SAML 2.0 authentication with WorkSpaces, the IdP must support
	// IdP-initiated deep linking for the relay state URL. Consult your IdP
	// documentation for more information.
	RelayStateParameterName *string

	// Indicates the status of SAML 2.0 authentication. These statuses include the
	// following.
	//
	//   - If the setting is DISABLED , end users will be directed to login with their
	//   directory credentials.
	//
	//   - If the setting is ENABLED , end users will be directed to login via the user
	//   access URL. Users attempting to connect to WorkSpaces from a client application
	//   that does not support SAML 2.0 authentication will not be able to connect.
	//
	//   - If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK , end users will be
	//   directed to login via the user access URL on supported client applications, but
	//   will not prevent clients that do not support SAML 2.0 authentication from
	//   connecting as if SAML 2.0 authentication was disabled.
	Status SamlStatusEnum

	// The SAML 2.0 identity provider (IdP) user access URL is the URL a user would
	// navigate to in their web browser in order to federate from the IdP and directly
	// access the application, without any SAML 2.0 service provider (SP) bindings.
	UserAccessUrl *string
	// contains filtered or unexported fields
}

Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

type SamlStatusEnum added in v1.22.0 

type SamlStatusEnum string
const (
	SamlStatusEnumDisabled                          SamlStatusEnum = "DISABLED"
	SamlStatusEnumEnabled                           SamlStatusEnum = "ENABLED"
	SamlStatusEnumEnabledWithDirectoryLoginFallback SamlStatusEnum = "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK"
)

Enum values for SamlStatusEnum

func (SamlStatusEnum) Values added in v1.22.0 

func (SamlStatusEnum) Values() []SamlStatusEnum

Values returns all known values for SamlStatusEnum. 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
	// contains filtered or unexported fields
}

Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

type SessionConnectionState added in v1.42.0 

type SessionConnectionState string
const (
	SessionConnectionStateConnected    SessionConnectionState = "CONNECTED"
	SessionConnectionStateNotConnected SessionConnectionState = "NOT_CONNECTED"
)

Enum values for SessionConnectionState

func (SessionConnectionState) Values added in v1.42.0 

func (SessionConnectionState) Values() []SessionConnectionState

Values returns all known values for SessionConnectionState. 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 Snapshot 

type Snapshot struct {

	// The time when the snapshot was created.
	SnapshotTime *time.Time
	// contains filtered or unexported fields
}

Describes a snapshot.

type StandbyWorkspace added in v1.27.0 

type StandbyWorkspace struct {

	// The identifier of the directory for the standby WorkSpace.
	//
	// This member is required.
	DirectoryId *string

	// The identifier of the standby WorkSpace.
	//
	// This member is required.
	PrimaryWorkspaceId *string

	// Indicates whether data replication is enabled, and if enabled, the type of data
	// replication.
	DataReplication DataReplication

	// The tags associated with the standby WorkSpace.
	Tags []Tag

	// The volume encryption key of the standby WorkSpace.
	VolumeEncryptionKey *string
	// contains filtered or unexported fields
}

Describes a standby WorkSpace.

type StandbyWorkspaceRelationshipType added in v1.27.0 

type StandbyWorkspaceRelationshipType string
const (
	StandbyWorkspaceRelationshipTypePrimary StandbyWorkspaceRelationshipType = "PRIMARY"
	StandbyWorkspaceRelationshipTypeStandby StandbyWorkspaceRelationshipType = "STANDBY"
)

Enum values for StandbyWorkspaceRelationshipType

func (StandbyWorkspaceRelationshipType) Values added in v1.27.0 

func (StandbyWorkspaceRelationshipType) Values() []StandbyWorkspaceRelationshipType

Values returns all known values for StandbyWorkspaceRelationshipType. 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 StandbyWorkspacesProperties added in v1.34.0 

type StandbyWorkspacesProperties struct {

	// Indicates whether data replication is enabled, and if enabled, the type of data
	// replication.
	DataReplication DataReplication

	// The date and time at which the last successful snapshot was taken of the
	// primary WorkSpace used for replicating data.
	RecoverySnapshotTime *time.Time

	// The identifier of the standby WorkSpace
	StandbyWorkspaceId *string
	// contains filtered or unexported fields
}

Describes the properties of the related standby WorkSpaces.

type StartRequest 

type StartRequest struct {

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

Information used to start a WorkSpace.

type StopRequest 

type StopRequest struct {

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

Describes the information used to stop a WorkSpace.

type StorageConnector added in v1.42.0 

type StorageConnector struct {

	// The type of connector used to save user files.
	//
	// This member is required.
	ConnectorType StorageConnectorTypeEnum

	// Indicates if the storage connetor is enabled or disabled.
	//
	// This member is required.
	Status StorageConnectorStatusEnum
	// contains filtered or unexported fields
}

Describes the storage connector.

type StorageConnectorStatusEnum added in v1.42.0 

type StorageConnectorStatusEnum string
const (
	StorageConnectorStatusEnumEnabled  StorageConnectorStatusEnum = "ENABLED"
	StorageConnectorStatusEnumDisabled StorageConnectorStatusEnum = "DISABLED"
)

Enum values for StorageConnectorStatusEnum

func (StorageConnectorStatusEnum) Values added in v1.42.0 

func (StorageConnectorStatusEnum) Values() []StorageConnectorStatusEnum

Values returns all known values for StorageConnectorStatusEnum. 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 StorageConnectorTypeEnum added in v1.42.0 

type StorageConnectorTypeEnum string
const (
	StorageConnectorTypeEnumHomeFolder StorageConnectorTypeEnum = "HOME_FOLDER"
)

Enum values for StorageConnectorTypeEnum

func (StorageConnectorTypeEnum) Values added in v1.42.0 

func (StorageConnectorTypeEnum) Values() []StorageConnectorTypeEnum

Values returns all known values for StorageConnectorTypeEnum. 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 StreamingExperiencePreferredProtocolEnum added in v1.42.0 

type StreamingExperiencePreferredProtocolEnum string
const (
	StreamingExperiencePreferredProtocolEnumTcp StreamingExperiencePreferredProtocolEnum = "TCP"
	StreamingExperiencePreferredProtocolEnumUdp StreamingExperiencePreferredProtocolEnum = "UDP"
)

Enum values for StreamingExperiencePreferredProtocolEnum

func (StreamingExperiencePreferredProtocolEnum) Values added in v1.42.0 

func (StreamingExperiencePreferredProtocolEnum) Values() []StreamingExperiencePreferredProtocolEnum

Values returns all known values for StreamingExperiencePreferredProtocolEnum. 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 StreamingProperties added in v1.42.0 

type StreamingProperties struct {

	// Indicates the Global Accelerator properties.
	GlobalAccelerator *GlobalAcceleratorForDirectory

	// Indicates the storage connector used
	StorageConnectors []StorageConnector

	// Indicates the type of preferred protocol for the streaming experience.
	StreamingExperiencePreferredProtocol StreamingExperiencePreferredProtocolEnum

	// Indicates the permission settings asscoiated with the user.
	UserSettings []UserSetting
	// contains filtered or unexported fields
}

Describes the streaming properties.

type Tag 

type Tag struct {

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

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

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
	// contains filtered or unexported fields
}

Describes the information used to terminate a WorkSpace.

type TimeoutSettings added in v1.42.0 

type TimeoutSettings struct {

	// Specifies the amount of time, in seconds, that a streaming session remains
	// active after users disconnect. If users try to reconnect to the streaming
	// session after a disconnection or network interruption within the time set, they
	// are connected to their previous session. Otherwise, they are connected to a new
	// session with a new streaming instance.
	DisconnectTimeoutInSeconds *int32

	// The amount of time in seconds a connection will stay active while idle.
	IdleDisconnectTimeoutInSeconds *int32

	// Specifies the maximum amount of time, in seconds, that a streaming session can
	// remain active. If users are still connected to a streaming instance five minutes
	// before this limit is reached, they are prompted to save any open documents
	// before being disconnected. After this time elapses, the instance is terminated
	// and replaced by a new instance.
	MaxUserDurationInSeconds *int32
	// contains filtered or unexported fields
}

Describes the timeout settings for a pool of WorkSpaces.

type UnsupportedNetworkConfigurationException 

type UnsupportedNetworkConfigurationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces.

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 UpdateResult added in v1.7.0 

type UpdateResult struct {

	// A description of whether updates for the WorkSpace image are pending or
	// available.
	Description *string

	// Indicates whether updated drivers or other components are available for the
	// specified WorkSpace image.
	UpdateAvailable *bool
	// contains filtered or unexported fields
}

Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.

Only Windows 10 WorkSpace images can be programmatically updated at this time.

type UserIdentityType added in v1.42.0 

type UserIdentityType string
const (
	UserIdentityTypeCustomerManaged      UserIdentityType = "CUSTOMER_MANAGED"
	UserIdentityTypeAwsDirectoryService  UserIdentityType = "AWS_DIRECTORY_SERVICE"
	UserIdentityTypeAwsIamIdentityCenter UserIdentityType = "AWS_IAM_IDENTITY_CENTER"
)

Enum values for UserIdentityType

func (UserIdentityType) Values added in v1.42.0 

func (UserIdentityType) Values() []UserIdentityType

Values returns all known values for UserIdentityType. 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 UserSetting added in v1.42.0 

type UserSetting struct {

	// Indicates the type of action.
	//
	// This member is required.
	Action UserSettingActionEnum

	// Indicates if the setting is enabled or disabled.
	//
	// This member is required.
	Permission UserSettingPermissionEnum

	// Indicates the maximum character length for the specified user setting.
	MaximumLength *int32
	// contains filtered or unexported fields
}

Information about the user's permission settings.

type UserSettingActionEnum added in v1.42.0 

type UserSettingActionEnum string
const (
	UserSettingActionEnumClipboardCopyFromLocalDevice UserSettingActionEnum = "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"
	UserSettingActionEnumClipboardCopyToLocalDevice   UserSettingActionEnum = "CLIPBOARD_COPY_TO_LOCAL_DEVICE"
	UserSettingActionEnumPrintingToLocalDevice        UserSettingActionEnum = "PRINTING_TO_LOCAL_DEVICE"
	UserSettingActionEnumSmartCard                    UserSettingActionEnum = "SMART_CARD"
)

Enum values for UserSettingActionEnum

func (UserSettingActionEnum) Values added in v1.42.0 

func (UserSettingActionEnum) Values() []UserSettingActionEnum

Values returns all known values for UserSettingActionEnum. 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 UserSettingPermissionEnum added in v1.42.0 

type UserSettingPermissionEnum string
const (
	UserSettingPermissionEnumEnabled  UserSettingPermissionEnum = "ENABLED"
	UserSettingPermissionEnumDisabled UserSettingPermissionEnum = "DISABLED"
)

Enum values for UserSettingPermissionEnum

func (UserSettingPermissionEnum) Values added in v1.42.0 

func (UserSettingPermissionEnum) Values() []UserSettingPermissionEnum

Values returns all known values for UserSettingPermissionEnum. 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 UserStorage 

type UserStorage struct {

	// The size of the user volume.
	//
	// This member is required.
	Capacity *string
	// contains filtered or unexported fields
}

Describes the user volume for a WorkSpace bundle.

type ValidationException added in v1.39.0 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId .

func (*ValidationException) Error added in v1.39.0 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode added in v1.39.0 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault added in v1.39.0 

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

func (*ValidationException) ErrorMessage added in v1.39.0 

func (e *ValidationException) ErrorMessage() string

type WorkSpaceApplication added in v1.31.0 

type WorkSpaceApplication struct {

	// The identifier of the application.
	ApplicationId *string

	// The time the application is created.
	Created *time.Time

	// The description of the WorkSpace application.
	Description *string

	// The license availability for the applications.
	LicenseType WorkSpaceApplicationLicenseType

	// The name of the WorkSpace application.
	Name *string

	// The owner of the WorkSpace application.
	Owner *string

	// The status of WorkSpace application.
	State WorkSpaceApplicationState

	// The supported compute types of the WorkSpace application.
	SupportedComputeTypeNames []Compute

	// The supported operating systems of the WorkSpace application.
	SupportedOperatingSystemNames []OperatingSystemName
	// contains filtered or unexported fields
}

Describes the WorkSpace application.

type WorkSpaceApplicationDeployment added in v1.31.0 

type WorkSpaceApplicationDeployment struct {

	// The associations between the applications and the associated resources.
	Associations []WorkspaceResourceAssociation
	// contains filtered or unexported fields
}

Describes the WorkSpace application deployment.

type WorkSpaceApplicationLicenseType added in v1.31.0 

type WorkSpaceApplicationLicenseType string
const (
	WorkSpaceApplicationLicenseTypeLicensed   WorkSpaceApplicationLicenseType = "LICENSED"
	WorkSpaceApplicationLicenseTypeUnlicensed WorkSpaceApplicationLicenseType = "UNLICENSED"
)

Enum values for WorkSpaceApplicationLicenseType

func (WorkSpaceApplicationLicenseType) Values added in v1.31.0 

func (WorkSpaceApplicationLicenseType) Values() []WorkSpaceApplicationLicenseType

Values returns all known values for WorkSpaceApplicationLicenseType. 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 WorkSpaceApplicationState added in v1.31.0 

type WorkSpaceApplicationState string
const (
	WorkSpaceApplicationStatePending       WorkSpaceApplicationState = "PENDING"
	WorkSpaceApplicationStateError         WorkSpaceApplicationState = "ERROR"
	WorkSpaceApplicationStateAvailable     WorkSpaceApplicationState = "AVAILABLE"
	WorkSpaceApplicationStateUninstallOnly WorkSpaceApplicationState = "UNINSTALL_ONLY"
)

Enum values for WorkSpaceApplicationState

func (WorkSpaceApplicationState) Values added in v1.31.0 

func (WorkSpaceApplicationState) Values() []WorkSpaceApplicationState

Values returns all known values for WorkSpaceApplicationState. 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 WorkSpaceAssociatedResourceType added in v1.31.0 

type WorkSpaceAssociatedResourceType string
const (
	WorkSpaceAssociatedResourceTypeApplication WorkSpaceAssociatedResourceType = "APPLICATION"
)

Enum values for WorkSpaceAssociatedResourceType

func (WorkSpaceAssociatedResourceType) Values added in v1.31.0 

func (WorkSpaceAssociatedResourceType) Values() []WorkSpaceAssociatedResourceType

Values returns all known values for WorkSpaceAssociatedResourceType. 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 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].
	//
	// [Launch a WorkSpace]: https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html
	ComputerName *string

	// Indicates the settings of the data replication.
	DataReplicationSettings *DataReplicationSettings

	// The identifier of the 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

	// The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
	RelatedWorkspaces []RelatedWorkspaceProperties

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

	// The properties of the standby WorkSpace
	StandbyWorkspacesProperties []StandbyWorkspacesProperties

	// The operational state of the WorkSpace.
	//
	//   - PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is
	//   being created).
	//
	//   - AVAILABLE – The WorkSpace is running and has passed the health checks.
	//
	//   - IMPAIRED – Refer to UNHEALTHY state.
	//
	//   - UNHEALTHY – The WorkSpace is not responding to health checks.
	//
	//   - REBOOTING – The WorkSpace is being rebooted (restarted).
	//
	//   - STARTING – The WorkSpace is starting up and health checks are being run.
	//
	//   - REBUILDING – The WorkSpace is being rebuilt.
	//
	//   - RESTORING – The WorkSpace is being restored.
	//
	//   - MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon
	//   Web Services.
	//
	//   - ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the
	//   WorkSpaces administrator.
	//
	//   - TERMINATING – The WorkSpace is being deleted.
	//
	//   - TERMINATED – The WorkSpace has been deleted.
	//
	//   - SUSPENDED – The WorkSpace has been suspended for image creation.
	//
	//   - UPDATING – The WorkSpace is undergoing an update.
	//
	//   - STOPPING – The WorkSpace is being stopped.
	//
	//   - STOPPED – The WorkSpace has been stopped.
	//
	//   - ERROR – The WorkSpace is an error state (for example, an error occurred
	//   during startup).
	//
	// 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]. If the WorkSpace ID isn't returned, then the WorkSpace has been
	// successfully terminated.
	//
	// [DescribeWorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html
	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 ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
	// Amazon WorkSpaces does not support asymmetric KMS keys.
	VolumeEncryptionKey *string

	// The identifier of the WorkSpace.
	WorkspaceId *string

	// The name of the user-decoupled WorkSpace.
	WorkspaceName *string

	// The properties of the WorkSpace.
	WorkspaceProperties *WorkspaceProperties
	// contains filtered or unexported fields
}

Describes a WorkSpace.

type WorkspaceAccessProperties 

type WorkspaceAccessProperties struct {

	// Indicates whether users can use Android and Android-compatible Chrome OS
	// 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 Linux clients to access their WorkSpaces.
	DeviceTypeLinux AccessPropertyValue

	// Indicates whether users can use macOS clients to access their WorkSpaces.
	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.
	DeviceTypeWindows AccessPropertyValue

	// Indicates whether users can use zero client devices to access their WorkSpaces.
	DeviceTypeZeroClient AccessPropertyValue
	// contains filtered or unexported fields
}

The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.

type WorkspaceBundle 

type WorkspaceBundle struct {

	// The identifier of the bundle.
	BundleId *string

	// The type of WorkSpace bundle.
	BundleType BundleType

	// The compute type of the bundle. For more information, see [Amazon WorkSpaces Bundles].
	//
	// [Amazon WorkSpaces Bundles]: http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles
	ComputeType *ComputeType

	// The time when the bundle was created.
	CreationTime *time.Time

	// The description of the bundle.
	Description *string

	// The identifier of the image that was used to create 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 Amazon Web Services.
	Owner *string

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

	// The state of the WorkSpace bundle.
	State WorkspaceBundleState

	// The size of the user volume.
	UserStorage *UserStorage
	// contains filtered or unexported fields
}

Describes a WorkSpace bundle.

type WorkspaceBundleState added in v1.27.0 

type WorkspaceBundleState string
const (
	WorkspaceBundleStateAvailable WorkspaceBundleState = "AVAILABLE"
	WorkspaceBundleStatePending   WorkspaceBundleState = "PENDING"
	WorkspaceBundleStateError     WorkspaceBundleState = "ERROR"
)

Enum values for WorkspaceBundleState

func (WorkspaceBundleState) Values added in v1.27.0 

func (WorkspaceBundleState) Values() []WorkspaceBundleState

Values returns all known values for WorkspaceBundleState. 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 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
	// contains filtered or unexported fields
}

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]in the Microsoft documentation.
	//
	//   - The API doesn't validate whether the OU exists.
	//
	// [Distinguished Names]: https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names
	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].
	//
	// [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]in the Amazon WorkDocs Administration Guide. To
	// delete a WorkDocs site, see [Deleting a Site]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.
	//
	// [Deleting a Site]: https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html
	// [Disabling Users]: https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html
	EnableWorkDocs *bool

	// Indicates the IAM role ARN of the instance.
	InstanceIamRoleArn *string

	// Indicates whether users are local administrators of their WorkSpaces.
	UserEnabledAsLocalAdministrator *bool
	// contains filtered or unexported fields
}

Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

type WorkspaceDirectory 

type WorkspaceDirectory struct {

	// Information about the Active Directory config.
	ActiveDirectoryConfig *ActiveDirectoryConfig

	// The directory alias.
	Alias *string

	// The certificate-based authentication properties used to authenticate SAML 2.0
	// Identity Provider (IdP) user identities to Active Directory for WorkSpaces
	// login.
	CertificateBasedAuthProperties *CertificateBasedAuthProperties

	// 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 error message returned.
	ErrorMessage *string

	// Specifies details about identity center configurations.
	IDCConfig *IDCConfig

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

	// Specifies details about Microsoft Entra configurations.
	MicrosoftEntraConfig *MicrosoftEntraConfig

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

	// Describes the enablement status, user access URL, and relay state parameter
	// name that are used for configuring federation with an SAML 2.0 identity
	// provider.
	SamlProperties *SamlProperties

	// 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]. If the directory ID isn't returned, then the directory has been successfully
	// deregistered.
	//
	// [DescribeWorkspaceDirectories]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html
	State WorkspaceDirectoryState

	// The streaming properties to configure.
	StreamingProperties *StreamingProperties

	// 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]
	// .
	//
	// [Bring Your Own Windows Desktop Images]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
	Tenancy Tenancy

	// Indicates the identity type of the specifired user.
	UserIdentityType UserIdentityType

	// 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 description of the WorkSpace directory
	WorkspaceDirectoryDescription *string

	// The name fo the WorkSpace directory.
	WorkspaceDirectoryName *string

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

	// Indicates whether the directory's WorkSpace type is personal or pools.
	WorkspaceType WorkspaceType
	// contains filtered or unexported fields
}

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"
	WorkspaceDirectoryTypeCustomerManaged      WorkspaceDirectoryType = "CUSTOMER_MANAGED"
	WorkspaceDirectoryTypeAwsIamIdentityCenter WorkspaceDirectoryType = "AWS_IAM_IDENTITY_CENTER"
)

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 Amazon
	// Web Services 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

	// Additional details of the error returned for the image, including the possible
	// causes of the errors and troubleshooting information.
	ErrorDetails []ErrorDetails

	// 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 Amazon Web Services 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].
	//
	// [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

	// The updates (if any) that are available for the specified image.
	Updates *UpdateResult
	// contains filtered or unexported fields
}

Describes a WorkSpace image.

type WorkspaceImageErrorDetailCode added in v1.30.0 

type WorkspaceImageErrorDetailCode string
const (
	WorkspaceImageErrorDetailCodeOutdatedPowershellVersion              WorkspaceImageErrorDetailCode = "OutdatedPowershellVersion"
	WorkspaceImageErrorDetailCodeOfficeInstalled                        WorkspaceImageErrorDetailCode = "OfficeInstalled"
	WorkspaceImageErrorDetailCodePcoipAgentInstalled                    WorkspaceImageErrorDetailCode = "PCoIPAgentInstalled"
	WorkspaceImageErrorDetailCodeWindowsUpdatesEnabled                  WorkspaceImageErrorDetailCode = "WindowsUpdatesEnabled"
	WorkspaceImageErrorDetailCodeAutoMountDisabled                      WorkspaceImageErrorDetailCode = "AutoMountDisabled"
	WorkspaceImageErrorDetailCodeWorkspacesByolAccountNotFound          WorkspaceImageErrorDetailCode = "WorkspacesBYOLAccountNotFound"
	WorkspaceImageErrorDetailCodeWorkspacesByolAccountDisabled          WorkspaceImageErrorDetailCode = "WorkspacesBYOLAccountDisabled"
	WorkspaceImageErrorDetailCodeDhcpDisabled                           WorkspaceImageErrorDetailCode = "DHCPDisabled"
	WorkspaceImageErrorDetailCodeDiskFreeSpace                          WorkspaceImageErrorDetailCode = "DiskFreeSpace"
	WorkspaceImageErrorDetailCodeAdditionalDrivesAttached               WorkspaceImageErrorDetailCode = "AdditionalDrivesAttached"
	WorkspaceImageErrorDetailCodeOsNotSupported                         WorkspaceImageErrorDetailCode = "OSNotSupported"
	WorkspaceImageErrorDetailCodeDomainJoined                           WorkspaceImageErrorDetailCode = "DomainJoined"
	WorkspaceImageErrorDetailCodeAzureDomainJoined                      WorkspaceImageErrorDetailCode = "AzureDomainJoined"
	WorkspaceImageErrorDetailCodeFirewallEnabled                        WorkspaceImageErrorDetailCode = "FirewallEnabled"
	WorkspaceImageErrorDetailCodeVmwareToolsInstalled                   WorkspaceImageErrorDetailCode = "VMWareToolsInstalled"
	WorkspaceImageErrorDetailCodeDiskSizeExceeded                       WorkspaceImageErrorDetailCode = "DiskSizeExceeded"
	WorkspaceImageErrorDetailCodeIncompatiblePartitioning               WorkspaceImageErrorDetailCode = "IncompatiblePartitioning"
	WorkspaceImageErrorDetailCodePendingReboot                          WorkspaceImageErrorDetailCode = "PendingReboot"
	WorkspaceImageErrorDetailCodeAutoLogonEnabled                       WorkspaceImageErrorDetailCode = "AutoLogonEnabled"
	WorkspaceImageErrorDetailCodeRealtimeUniversalDisabled              WorkspaceImageErrorDetailCode = "RealTimeUniversalDisabled"
	WorkspaceImageErrorDetailCodeMultipleBootPartition                  WorkspaceImageErrorDetailCode = "MultipleBootPartition"
	WorkspaceImageErrorDetailCodeSixtyFourBitOs                         WorkspaceImageErrorDetailCode = "Requires64BitOS"
	WorkspaceImageErrorDetailCodeZeroRearmCount                         WorkspaceImageErrorDetailCode = "ZeroRearmCount"
	WorkspaceImageErrorDetailCodeInPlaceUpgrade                         WorkspaceImageErrorDetailCode = "InPlaceUpgrade"
	WorkspaceImageErrorDetailCodeAntiVirusInstalled                     WorkspaceImageErrorDetailCode = "AntiVirusInstalled"
	WorkspaceImageErrorDetailCodeUefiNotSupported                       WorkspaceImageErrorDetailCode = "UEFINotSupported"
	WorkspaceImageErrorDetailCodeUnknownError                           WorkspaceImageErrorDetailCode = "UnknownError"
	WorkspaceImageErrorDetailCodeAppxPackagesInstalled                  WorkspaceImageErrorDetailCode = "AppXPackagesInstalled"
	WorkspaceImageErrorDetailCodeReservedStorageInUse                   WorkspaceImageErrorDetailCode = "ReservedStorageInUse"
	WorkspaceImageErrorDetailCodeAdditionalDrivesPresent                WorkspaceImageErrorDetailCode = "AdditionalDrivesPresent"
	WorkspaceImageErrorDetailCodeWindowsUpdatesRequired                 WorkspaceImageErrorDetailCode = "WindowsUpdatesRequired"
	WorkspaceImageErrorDetailCodeSysprepFileMissing                     WorkspaceImageErrorDetailCode = "SysPrepFileMissing"
	WorkspaceImageErrorDetailCodeUserProfileMissing                     WorkspaceImageErrorDetailCode = "UserProfileMissing"
	WorkspaceImageErrorDetailCodeInsufficientDiskSpace                  WorkspaceImageErrorDetailCode = "InsufficientDiskSpace"
	WorkspaceImageErrorDetailCodeEnvironmentVariablesPathMissingEntries WorkspaceImageErrorDetailCode = "EnvironmentVariablesPathMissingEntries"
	WorkspaceImageErrorDetailCodeDomainAccountServicesFound             WorkspaceImageErrorDetailCode = "DomainAccountServicesFound"
	WorkspaceImageErrorDetailCodeInvalidIp                              WorkspaceImageErrorDetailCode = "InvalidIp"
	WorkspaceImageErrorDetailCodeRemoteDesktopServicesDisabled          WorkspaceImageErrorDetailCode = "RemoteDesktopServicesDisabled"
	WorkspaceImageErrorDetailCodeWindowsModulesInstallerDisabled        WorkspaceImageErrorDetailCode = "WindowsModulesInstallerDisabled"
	WorkspaceImageErrorDetailCodeAmazonSsmAgentEnabled                  WorkspaceImageErrorDetailCode = "AmazonSsmAgentEnabled"
	WorkspaceImageErrorDetailCodeUnsupportedSecurityProtocol            WorkspaceImageErrorDetailCode = "UnsupportedSecurityProtocol"
	WorkspaceImageErrorDetailCodeMultipleUserProfiles                   WorkspaceImageErrorDetailCode = "MultipleUserProfiles"
	WorkspaceImageErrorDetailCodeStagedAppxPackage                      WorkspaceImageErrorDetailCode = "StagedAppxPackage"
	WorkspaceImageErrorDetailCodeUnsupportedOsUpgrade                   WorkspaceImageErrorDetailCode = "UnsupportedOsUpgrade"
	WorkspaceImageErrorDetailCodeInsufficientRearmCount                 WorkspaceImageErrorDetailCode = "InsufficientRearmCount"
)

Enum values for WorkspaceImageErrorDetailCode

func (WorkspaceImageErrorDetailCode) Values added in v1.30.0 

func (WorkspaceImageErrorDetailCode) Values() []WorkspaceImageErrorDetailCode

Values returns all known values for WorkspaceImageErrorDetailCode. 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 WorkspaceImageIngestionProcess 

type WorkspaceImageIngestionProcess string
const (
	WorkspaceImageIngestionProcessByolRegular          WorkspaceImageIngestionProcess = "BYOL_REGULAR"
	WorkspaceImageIngestionProcessByolGraphics         WorkspaceImageIngestionProcess = "BYOL_GRAPHICS"
	WorkspaceImageIngestionProcessByolGraphicspro      WorkspaceImageIngestionProcess = "BYOL_GRAPHICSPRO"
	WorkspaceImageIngestionProcessByolGraphicsG4dn     WorkspaceImageIngestionProcess = "BYOL_GRAPHICS_G4DN"
	WorkspaceImageIngestionProcessByolRegularWsp       WorkspaceImageIngestionProcess = "BYOL_REGULAR_WSP"
	WorkspaceImageIngestionProcessByolGraphicsG4dnWsp  WorkspaceImageIngestionProcess = "BYOL_GRAPHICS_G4DN_WSP"
	WorkspaceImageIngestionProcessByolRegularByop      WorkspaceImageIngestionProcess = "BYOL_REGULAR_BYOP"
	WorkspaceImageIngestionProcessByolGraphicsG4dnByop WorkspaceImageIngestionProcess = "BYOL_GRAPHICS_G4DN_BYOP"
)

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].
	//
	// [Amazon WorkSpaces Bundles]: http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles
	ComputeTypeName Compute

	// Indicates the Global Accelerator properties.
	GlobalAccelerator *GlobalAcceleratorForWorkSpace

	// The name of the operating system.
	OperatingSystemName OperatingSystemName

	// The protocol. For more information, see [Protocols for Amazon WorkSpaces].
	//
	//   - Only available for WorkSpaces created with PCoIP bundles.
	//
	//   - The Protocols property is case sensitive. Ensure you use PCOIP or DCV
	//   (formerly WSP).
	//
	//   - Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles
	//   (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
	//
	// [Protocols for Amazon WorkSpaces]: https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html
	Protocols []Protocol

	// 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].
	//
	// [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].
	//
	// The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your
	// account team to be allow-listed to use this value. For more information, see [Amazon WorkSpaces Core].
	//
	// Review your running mode to ensure you are using one that is optimal for your
	// needs and budget. For more information on switching running modes, see [Can I switch between hourly and monthly billing?]
	//
	// [Manage the WorkSpace Running Mode]: https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html
	// [Can I switch between hourly and monthly billing?]: http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F
	// [Amazon WorkSpaces Core]: http://aws.amazon.com/workspaces/core/
	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].
	//
	// [Modify a WorkSpace]: https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html
	UserVolumeSizeGib *int32
	// contains filtered or unexported fields
}

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 Directory Service directory for the WorkSpace. You can
	// use DescribeWorkspaceDirectoriesto 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
	// Directory Service directory for the WorkSpace.
	//
	// The username is not case-sensitive, but we recommend matching the case in the
	// Directory Service directory to avoid potential incompatibilities.
	//
	// The reserved keyword, [UNDEFINED] , is used when creating user-decoupled
	// WorkSpaces.
	//
	// 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 ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
	// Amazon WorkSpaces does not support asymmetric KMS keys.
	VolumeEncryptionKey *string

	// The name of the user-decoupled WorkSpace.
	//
	// WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled
	// WorkSpaces. WorkspaceName is not applicable if UserName is specified for
	// user-assigned WorkSpaces.
	WorkspaceName *string

	// The WorkSpace properties.
	WorkspaceProperties *WorkspaceProperties
	// contains filtered or unexported fields
}

Describes the information used to create a WorkSpace.

type WorkspaceResourceAssociation added in v1.31.0 

type WorkspaceResourceAssociation struct {

	// The identifier of the associated resource.
	AssociatedResourceId *string

	// The resource types of the associated resource.
	AssociatedResourceType WorkSpaceAssociatedResourceType

	// The time the association is created.
	Created *time.Time

	// The time the association status was last updated.
	LastUpdatedTime *time.Time

	// The status of the WorkSpace resource association.
	State AssociationState

	// The reason the association deployment failed.
	StateReason *AssociationStateReason

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

Describes the association between an application and a WorkSpace resource.

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 WorkspaceType added in v1.42.0 

type WorkspaceType string
const (
	WorkspaceTypePersonal WorkspaceType = "PERSONAL"
	WorkspaceTypePools    WorkspaceType = "POOLS"
)

Enum values for WorkspaceType

func (WorkspaceType) Values added in v1.42.0 

func (WorkspaceType) Values() []WorkspaceType

Values returns all known values for WorkspaceType. 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

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

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
	// contains filtered or unexported fields
}

Describes an IP access control group.

type WorkspacesPool added in v1.42.0 

type WorkspacesPool struct {

	// The identifier of the bundle used by the pool.
	//
	// This member is required.
	BundleId *string

	// The capacity status for the pool
	//
	// This member is required.
	CapacityStatus *CapacityStatus

	// The time the pool was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The identifier of the directory used by the pool.
	//
	// This member is required.
	DirectoryId *string

	// The Amazon Resource Name (ARN) for the pool.
	//
	// This member is required.
	PoolArn *string

	// The identifier of a pool.
	//
	// This member is required.
	PoolId *string

	// The name of the pool,
	//
	// This member is required.
	PoolName *string

	// The current state of the pool.
	//
	// This member is required.
	State WorkspacesPoolState

	// The persistent application settings for users of the pool.
	ApplicationSettings *ApplicationSettingsResponse

	// The description of the pool.
	Description *string

	// The pool errors.
	Errors []WorkspacesPoolError

	// The amount of time that a pool session remains active after users disconnect.
	// If they try to reconnect to the pool session after a disconnection or network
	// interruption within this time interval, they are connected to their previous
	// session. Otherwise, they are connected to a new session with a new pool
	// instance.
	TimeoutSettings *TimeoutSettings
	// contains filtered or unexported fields
}

Describes a pool of WorkSpaces.

type WorkspacesPoolError added in v1.42.0 

type WorkspacesPoolError struct {

	// The error code.
	ErrorCode WorkspacesPoolErrorCode

	// The error message.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Describes a pool error.

type WorkspacesPoolErrorCode added in v1.42.0 

type WorkspacesPoolErrorCode string
const (
	WorkspacesPoolErrorCodeIamServiceRoleIsMissing                           WorkspacesPoolErrorCode = "IAM_SERVICE_ROLE_IS_MISSING"
	WorkspacesPoolErrorCodeIamServiceRoleMissingEniDescribeAction            WorkspacesPoolErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION"
	WorkspacesPoolErrorCodeIamServiceRoleMissingEniCreateAction              WorkspacesPoolErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION"
	WorkspacesPoolErrorCodeIamServiceRoleMissingEniDeleteAction              WorkspacesPoolErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION"
	WorkspacesPoolErrorCodeNetworkInterfaceLimitExceeded                     WorkspacesPoolErrorCode = "NETWORK_INTERFACE_LIMIT_EXCEEDED"
	WorkspacesPoolErrorCodeInternalServiceError                              WorkspacesPoolErrorCode = "INTERNAL_SERVICE_ERROR"
	WorkspacesPoolErrorCodeMachineRoleIsMissing                              WorkspacesPoolErrorCode = "MACHINE_ROLE_IS_MISSING"
	WorkspacesPoolErrorCodeStsDisabledInRegion                               WorkspacesPoolErrorCode = "STS_DISABLED_IN_REGION"
	WorkspacesPoolErrorCodeSubnetHasInsufficientIpAddresses                  WorkspacesPoolErrorCode = "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES"
	WorkspacesPoolErrorCodeIamServiceRoleMissingDescribeSubnetAction         WorkspacesPoolErrorCode = "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION"
	WorkspacesPoolErrorCodeSubnetNotFound                                    WorkspacesPoolErrorCode = "SUBNET_NOT_FOUND"
	WorkspacesPoolErrorCodeImageNotFound                                     WorkspacesPoolErrorCode = "IMAGE_NOT_FOUND"
	WorkspacesPoolErrorCodeInvalidSubnetConfiguration                        WorkspacesPoolErrorCode = "INVALID_SUBNET_CONFIGURATION"
	WorkspacesPoolErrorCodeSecurityGroupsNotFound                            WorkspacesPoolErrorCode = "SECURITY_GROUPS_NOT_FOUND"
	WorkspacesPoolErrorCodeIgwNotAttached                                    WorkspacesPoolErrorCode = "IGW_NOT_ATTACHED"
	WorkspacesPoolErrorCodeIamServiceRoleMissingDescribeSecurityGroupsAction WorkspacesPoolErrorCode = "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION"
	WorkspacesPoolErrorCodeWorkspacesPoolStopped                             WorkspacesPoolErrorCode = "WORKSPACES_POOL_STOPPED"
	WorkspacesPoolErrorCodeWorkspacesPoolInstanceProvisioningFailure         WorkspacesPoolErrorCode = "WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE"
	WorkspacesPoolErrorCodeDomainJoinErrorFileNotFound                       WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND"
	WorkspacesPoolErrorCodeDomainJoinErrorAccessDenied                       WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_ACCESS_DENIED"
	WorkspacesPoolErrorCodeDomainJoinErrorLogonFailure                       WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_LOGON_FAILURE"
	WorkspacesPoolErrorCodeDomainJoinErrorInvalidParameter                   WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_INVALID_PARAMETER"
	WorkspacesPoolErrorCodeDomainJoinErrorMoreData                           WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_MORE_DATA"
	WorkspacesPoolErrorCodeDomainJoinErrorNoSuchDomain                       WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN"
	WorkspacesPoolErrorCodeDomainJoinErrorNotSupported                       WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_NOT_SUPPORTED"
	WorkspacesPoolErrorCodeDomainJoinNerrInvalidWorkgroupName                WorkspacesPoolErrorCode = "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME"
	WorkspacesPoolErrorCodeDomainJoinNerrWorkstationNotStarted               WorkspacesPoolErrorCode = "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED"
	WorkspacesPoolErrorCodeDomainJoinErrorDsMachineAccountQuotaExceeded      WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED"
	WorkspacesPoolErrorCodeDomainJoinNerrPasswordExpired                     WorkspacesPoolErrorCode = "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED"
	WorkspacesPoolErrorCodeDomainJoinInternalServiceError                    WorkspacesPoolErrorCode = "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"
	WorkspacesPoolErrorCodeDomainJoinErrorSecretActionPermissionIsMissing    WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING"
	WorkspacesPoolErrorCodeDomainJoinErrorSecretDecryptionFailure            WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE"
	WorkspacesPoolErrorCodeDomainJoinErrorSecretStateInvalid                 WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID"
	WorkspacesPoolErrorCodeDomainJoinErrorSecretNotFound                     WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND"
	WorkspacesPoolErrorCodeDomainJoinErrorSecretValueKeyNotFound             WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND"
	WorkspacesPoolErrorCodeDomainJoinErrorSecretInvalid                      WorkspacesPoolErrorCode = "DOMAIN_JOIN_ERROR_SECRET_INVALID"
	WorkspacesPoolErrorCodeBundleNotFound                                    WorkspacesPoolErrorCode = "BUNDLE_NOT_FOUND"
	WorkspacesPoolErrorCodeDirectoryNotFound                                 WorkspacesPoolErrorCode = "DIRECTORY_NOT_FOUND"
	WorkspacesPoolErrorCodeInsufficientPermissionsError                      WorkspacesPoolErrorCode = "INSUFFICIENT_PERMISSIONS_ERROR"
	WorkspacesPoolErrorCodeDefaultOuIsMissing                                WorkspacesPoolErrorCode = "DEFAULT_OU_IS_MISSING"
)

Enum values for WorkspacesPoolErrorCode

func (WorkspacesPoolErrorCode) Values added in v1.42.0 

func (WorkspacesPoolErrorCode) Values() []WorkspacesPoolErrorCode

Values returns all known values for WorkspacesPoolErrorCode. 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 WorkspacesPoolSession added in v1.42.0 

type WorkspacesPoolSession struct {

	// The identifier of the pool.
	//
	// This member is required.
	PoolId *string

	// The identifier of the session.
	//
	// This member is required.
	SessionId *string

	// The identifier of the user.
	//
	// This member is required.
	UserId *string

	// The authentication method. The user is authenticated using a WorkSpaces Pools
	// URL (API) or SAML 2.0 federation (SAML).
	AuthenticationType AuthenticationType

	// Specifies whether a user is connected to the pool session.
	ConnectionState SessionConnectionState

	// The time that the pool session ended.
	ExpirationTime *time.Time

	// The identifier for the instance hosting the session.
	InstanceId *string

	// Describes the network details of the pool.
	NetworkAccessConfiguration *NetworkAccessConfiguration

	// The time that the pool sission started.
	StartTime *time.Time
	// contains filtered or unexported fields
}

Describes a pool session.

type WorkspacesPoolState added in v1.42.0 

type WorkspacesPoolState string
const (
	WorkspacesPoolStateCreating WorkspacesPoolState = "CREATING"
	WorkspacesPoolStateDeleting WorkspacesPoolState = "DELETING"
	WorkspacesPoolStateRunning  WorkspacesPoolState = "RUNNING"
	WorkspacesPoolStateStarting WorkspacesPoolState = "STARTING"
	WorkspacesPoolStateStopped  WorkspacesPoolState = "STOPPED"
	WorkspacesPoolStateStopping WorkspacesPoolState = "STOPPING"
	WorkspacesPoolStateUpdating WorkspacesPoolState = "UPDATING"
)

Enum values for WorkspacesPoolState

func (WorkspacesPoolState) Values added in v1.42.0 

func (WorkspacesPoolState) Values() []WorkspacesPoolState

Values returns all known values for WorkspacesPoolState. 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.

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.