types

package
v0.0.0-...-68f2935 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	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 

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 

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 

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 Application 

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

Enum values for Application

func (Application) Values 

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 

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

Enum values for ApplicationAssociatedResourceType

func (ApplicationAssociatedResourceType) Values 

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 

type ApplicationNotSupportedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified application is not supported.

func (*ApplicationNotSupportedException) Error 

func (e *ApplicationNotSupportedException) Error() string

func (*ApplicationNotSupportedException) ErrorCode 

func (e *ApplicationNotSupportedException) ErrorCode() string

func (*ApplicationNotSupportedException) ErrorFault 

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

func (*ApplicationNotSupportedException) ErrorMessage 

func (e *ApplicationNotSupportedException) ErrorMessage() string

type ApplicationResourceAssociation 

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 AssociationErrorCode 

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 

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 

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 

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 

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 

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 

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 BundleAssociatedResourceType 

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

Enum values for BundleAssociatedResourceType

func (BundleAssociatedResourceType) Values 

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 

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 

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

Enum values for BundleType

func (BundleType) Values 

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 CertificateBasedAuthProperties 

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 

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

Enum values for CertificateBasedAuthStatusEnum

func (CertificateBasedAuthStatusEnum) Values 

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 

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 

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

Enum values for Compute

func (Compute) Values 

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 

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 

func (e *ComputeNotCompatibleException) Error() string

func (*ComputeNotCompatibleException) ErrorCode 

func (e *ComputeNotCompatibleException) ErrorCode() string

func (*ComputeNotCompatibleException) ErrorFault 

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

func (*ComputeNotCompatibleException) ErrorMessage 

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 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The TargetAccountId is already linked or invited.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

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

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConnectClientAddIn 

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 

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 

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 

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 

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

Enum values for ConnectionAliasState

func (ConnectionAliasState) Values 

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 

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 

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

Enum values for DataReplication

func (DataReplication) Values 

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 

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 

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

Enum values for DedicatedTenancyAccountType

func (DedicatedTenancyAccountType) Values 

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 

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 

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 

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 

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 

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

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

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

Enum values for DeletableCertificateBasedAuthProperty

func (DeletableCertificateBasedAuthProperty) Values 

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 

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 

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 ErrorDetails 

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 

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 ImageAssociatedResourceType 

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

Enum values for ImageAssociatedResourceType

func (ImageAssociatedResourceType) Values 

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 

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 

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 

type IncompatibleApplicationsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified application is not compatible with the resource.

func (*IncompatibleApplicationsException) Error 

func (e *IncompatibleApplicationsException) Error() string

func (*IncompatibleApplicationsException) ErrorCode 

func (e *IncompatibleApplicationsException) ErrorCode() string

func (*IncompatibleApplicationsException) ErrorFault 

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

func (*IncompatibleApplicationsException) ErrorMessage 

func (e *IncompatibleApplicationsException) ErrorMessage() string

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Unexpected server error occured.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

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

func (*InternalServerException) ErrorMessage 

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 

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 

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 

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

Enum values for LogUploadEnum

func (LogUploadEnum) Values 

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 ModificationResourceEnum 

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

Enum values for ModificationResourceEnum

func (ModificationResourceEnum) Values 

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 

func (ModificationStateEnum) Values() []ModificationStateEnum

Values returns all known values for ModificationStateEnum. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OperatingSystem 

type OperatingSystem struct {

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

The operating system that the image is running.

type OperatingSystemName 

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

Enum values for OperatingSystemName

func (OperatingSystemName) Values 

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 

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 

func (e *OperatingSystemNotCompatibleException) Error() string

func (*OperatingSystemNotCompatibleException) ErrorCode 

func (e *OperatingSystemNotCompatibleException) ErrorCode() string

func (*OperatingSystemNotCompatibleException) ErrorFault 

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

func (*OperatingSystemNotCompatibleException) ErrorMessage 

func (e *OperatingSystemNotCompatibleException) ErrorMessage() string

type OperatingSystemType 

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

Enum values for OperatingSystemType

func (OperatingSystemType) Values 

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 

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 

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

Enum values for Protocol

func (Protocol) Values 

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 

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 

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 

type ResourceInUseException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId *string
	// contains filtered or unexported fields
}

The specified resource is currently in use.

func (*ResourceInUseException) Error 

func (e *ResourceInUseException) Error() string

func (*ResourceInUseException) ErrorCode 

func (e *ResourceInUseException) ErrorCode() string

func (*ResourceInUseException) ErrorFault 

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

func (*ResourceInUseException) ErrorMessage 

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

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 

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 

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

Enum values for SamlStatusEnum

func (SamlStatusEnum) Values 

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 Snapshot 

type Snapshot struct {

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

Describes a snapshot.

type StandbyWorkspace 

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 

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

Enum values for StandbyWorkspaceRelationshipType

func (StandbyWorkspaceRelationshipType) Values 

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 

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

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 

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

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 UserStorage 

type UserStorage struct {

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

Describes the user volume for a WorkSpace bundle.

type ValidationException 

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 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

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

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type WorkSpaceApplication 

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 

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 

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

Enum values for WorkSpaceApplicationLicenseType

func (WorkSpaceApplicationLicenseType) Values 

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 

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

Enum values for WorkSpaceApplicationState

func (WorkSpaceApplicationState) Values 

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 

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

Enum values for WorkSpaceAssociatedResourceType

func (WorkSpaceAssociatedResourceType) Values 

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 

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

Enum values for WorkspaceBundleState

func (WorkspaceBundleState) Values 

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

	// 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 identifier of the IAM role. This is the role that allows Amazon WorkSpaces
	// to make calls to other services, such as Amazon EC2, on your behalf.
	IamRoleId *string

	// The identifiers of the IP access control groups associated with the directory.
	IpGroupIds []string

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

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

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

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

	// The identifier of the security group that is assigned to new WorkSpaces.
	WorkspaceSecurityGroupId *string
	// 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 

func (WorkspaceDirectoryState) Values() []WorkspaceDirectoryState

Values returns all known values for WorkspaceDirectoryState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkspaceDirectoryType 

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

Enum values for WorkspaceDirectoryType

func (WorkspaceDirectoryType) Values 

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 

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

Enum values for WorkspaceImageErrorDetailCode

func (WorkspaceImageErrorDetailCode) Values 

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"
	WorkspaceImageIngestionProcessByolRegularByop      WorkspaceImageIngestionProcess = "BYOL_REGULAR_BYOP"
	WorkspaceImageIngestionProcessByolGraphicsG4dnByop WorkspaceImageIngestionProcess = "BYOL_GRAPHICS_G4DN_BYOP"
)

Enum values for WorkspaceImageIngestionProcess

func (WorkspaceImageIngestionProcess) Values 

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 

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 

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

	// 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 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].
	//
	// [Manage the WorkSpace Running Mode]: https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html
	// [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 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 *string

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

Describes the information used to create a WorkSpace.

type WorkspaceResourceAssociation 

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 

func (WorkspaceState) Values() []WorkspaceState

Values returns all known values for WorkspaceState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkspacesDefaultRoleNotFoundException 

type WorkspacesDefaultRoleNotFoundException struct {
	Message *string

	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.

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.