workspaces

package
v1.50.11 Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2024 License: Apache-2.0 Imports: 10 Imported by: 101

Documentation

Overview

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

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/wsp.html) in the Amazon Web Services General Reference.

You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide (https://docs.aws.amazon.com/workspaces/latest/adminguide/). For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide (https://docs.aws.amazon.com/workspaces/latest/userguide/). For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference (https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html).

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

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

Using the Client

To contact Amazon WorkSpaces with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon WorkSpaces client WorkSpaces for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/workspaces/#New

Index

Constants

View Source 
const (
	// AccessPropertyValueAllow is a AccessPropertyValue enum value
	AccessPropertyValueAllow = "ALLOW"

	// AccessPropertyValueDeny is a AccessPropertyValue enum value
	AccessPropertyValueDeny = "DENY"
)
View Source 
const (
	// ApplicationMicrosoftOffice2016 is a Application enum value
	ApplicationMicrosoftOffice2016 = "Microsoft_Office_2016"

	// ApplicationMicrosoftOffice2019 is a Application enum value
	ApplicationMicrosoftOffice2019 = "Microsoft_Office_2019"
)
View Source 
const (
	// ApplicationAssociatedResourceTypeWorkspace is a ApplicationAssociatedResourceType enum value
	ApplicationAssociatedResourceTypeWorkspace = "WORKSPACE"

	// ApplicationAssociatedResourceTypeBundle is a ApplicationAssociatedResourceType enum value
	ApplicationAssociatedResourceTypeBundle = "BUNDLE"

	// ApplicationAssociatedResourceTypeImage is a ApplicationAssociatedResourceType enum value
	ApplicationAssociatedResourceTypeImage = "IMAGE"
)
View Source 
const (
	// AssociationErrorCodeValidationErrorInsufficientDiskSpace is a AssociationErrorCode enum value
	AssociationErrorCodeValidationErrorInsufficientDiskSpace = "ValidationError.InsufficientDiskSpace"

	// AssociationErrorCodeValidationErrorInsufficientMemory is a AssociationErrorCode enum value
	AssociationErrorCodeValidationErrorInsufficientMemory = "ValidationError.InsufficientMemory"

	// AssociationErrorCodeValidationErrorUnsupportedOperatingSystem is a AssociationErrorCode enum value
	AssociationErrorCodeValidationErrorUnsupportedOperatingSystem = "ValidationError.UnsupportedOperatingSystem"

	// AssociationErrorCodeDeploymentErrorInternalServerError is a AssociationErrorCode enum value
	AssociationErrorCodeDeploymentErrorInternalServerError = "DeploymentError.InternalServerError"

	// AssociationErrorCodeDeploymentErrorWorkspaceUnreachable is a AssociationErrorCode enum value
	AssociationErrorCodeDeploymentErrorWorkspaceUnreachable = "DeploymentError.WorkspaceUnreachable"
)
View Source 
const (
	// AssociationStatePendingInstall is a AssociationState enum value
	AssociationStatePendingInstall = "PENDING_INSTALL"

	// AssociationStatePendingInstallDeployment is a AssociationState enum value
	AssociationStatePendingInstallDeployment = "PENDING_INSTALL_DEPLOYMENT"

	// AssociationStatePendingUninstall is a AssociationState enum value
	AssociationStatePendingUninstall = "PENDING_UNINSTALL"

	// AssociationStatePendingUninstallDeployment is a AssociationState enum value
	AssociationStatePendingUninstallDeployment = "PENDING_UNINSTALL_DEPLOYMENT"

	// AssociationStateInstalling is a AssociationState enum value
	AssociationStateInstalling = "INSTALLING"

	// AssociationStateUninstalling is a AssociationState enum value
	AssociationStateUninstalling = "UNINSTALLING"

	// AssociationStateError is a AssociationState enum value
	AssociationStateError = "ERROR"

	// AssociationStateCompleted is a AssociationState enum value
	AssociationStateCompleted = "COMPLETED"

	// AssociationStateRemoved is a AssociationState enum value
	AssociationStateRemoved = "REMOVED"
)
View Source 
const (
	// AssociationStatusNotAssociated is a AssociationStatus enum value
	AssociationStatusNotAssociated = "NOT_ASSOCIATED"

	// AssociationStatusAssociatedWithOwnerAccount is a AssociationStatus enum value
	AssociationStatusAssociatedWithOwnerAccount = "ASSOCIATED_WITH_OWNER_ACCOUNT"

	// AssociationStatusAssociatedWithSharedAccount is a AssociationStatus enum value
	AssociationStatusAssociatedWithSharedAccount = "ASSOCIATED_WITH_SHARED_ACCOUNT"

	// AssociationStatusPendingAssociation is a AssociationStatus enum value
	AssociationStatusPendingAssociation = "PENDING_ASSOCIATION"

	// AssociationStatusPendingDisassociation is a AssociationStatus enum value
	AssociationStatusPendingDisassociation = "PENDING_DISASSOCIATION"
)
View Source 
const (
	// BundleTypeRegular is a BundleType enum value
	BundleTypeRegular = "REGULAR"

	// BundleTypeStandby is a BundleType enum value
	BundleTypeStandby = "STANDBY"
)
View Source 
const (
	// CertificateBasedAuthStatusEnumDisabled is a CertificateBasedAuthStatusEnum enum value
	CertificateBasedAuthStatusEnumDisabled = "DISABLED"

	// CertificateBasedAuthStatusEnumEnabled is a CertificateBasedAuthStatusEnum enum value
	CertificateBasedAuthStatusEnumEnabled = "ENABLED"
)
View Source 
const (
	// ClientDeviceTypeDeviceTypeWindows is a ClientDeviceType enum value
	ClientDeviceTypeDeviceTypeWindows = "DeviceTypeWindows"

	// ClientDeviceTypeDeviceTypeOsx is a ClientDeviceType enum value
	ClientDeviceTypeDeviceTypeOsx = "DeviceTypeOsx"

	// ClientDeviceTypeDeviceTypeAndroid is a ClientDeviceType enum value
	ClientDeviceTypeDeviceTypeAndroid = "DeviceTypeAndroid"

	// ClientDeviceTypeDeviceTypeIos is a ClientDeviceType enum value
	ClientDeviceTypeDeviceTypeIos = "DeviceTypeIos"

	// ClientDeviceTypeDeviceTypeLinux is a ClientDeviceType enum value
	ClientDeviceTypeDeviceTypeLinux = "DeviceTypeLinux"

	// ClientDeviceTypeDeviceTypeWeb is a ClientDeviceType enum value
	ClientDeviceTypeDeviceTypeWeb = "DeviceTypeWeb"
)
View Source 
const (
	// ComputeValue is a Compute enum value
	ComputeValue = "VALUE"

	// ComputeStandard is a Compute enum value
	ComputeStandard = "STANDARD"

	// ComputePerformance is a Compute enum value
	ComputePerformance = "PERFORMANCE"

	// ComputePower is a Compute enum value
	ComputePower = "POWER"

	// ComputeGraphics is a Compute enum value
	ComputeGraphics = "GRAPHICS"

	// ComputePowerpro is a Compute enum value
	ComputePowerpro = "POWERPRO"

	// ComputeGraphicspro is a Compute enum value
	ComputeGraphicspro = "GRAPHICSPRO"

	// ComputeGraphicsG4dn is a Compute enum value
	ComputeGraphicsG4dn = "GRAPHICS_G4DN"

	// ComputeGraphicsproG4dn is a Compute enum value
	ComputeGraphicsproG4dn = "GRAPHICSPRO_G4DN"
)
View Source 
const (
	// ConnectionAliasStateCreating is a ConnectionAliasState enum value
	ConnectionAliasStateCreating = "CREATING"

	// ConnectionAliasStateCreated is a ConnectionAliasState enum value
	ConnectionAliasStateCreated = "CREATED"

	// ConnectionAliasStateDeleting is a ConnectionAliasState enum value
	ConnectionAliasStateDeleting = "DELETING"
)
View Source 
const (
	// ConnectionStateConnected is a ConnectionState enum value
	ConnectionStateConnected = "CONNECTED"

	// ConnectionStateDisconnected is a ConnectionState enum value
	ConnectionStateDisconnected = "DISCONNECTED"

	// ConnectionStateUnknown is a ConnectionState enum value
	ConnectionStateUnknown = "UNKNOWN"
)
View Source 
const (
	// DataReplicationNoReplication is a DataReplication enum value
	DataReplicationNoReplication = "NO_REPLICATION"

	// DataReplicationPrimaryAsSource is a DataReplication enum value
	DataReplicationPrimaryAsSource = "PRIMARY_AS_SOURCE"
)
View Source 
const (
	// DedicatedTenancyModificationStateEnumPending is a DedicatedTenancyModificationStateEnum enum value
	DedicatedTenancyModificationStateEnumPending = "PENDING"

	// DedicatedTenancyModificationStateEnumCompleted is a DedicatedTenancyModificationStateEnum enum value
	DedicatedTenancyModificationStateEnumCompleted = "COMPLETED"

	// DedicatedTenancyModificationStateEnumFailed is a DedicatedTenancyModificationStateEnum enum value
	DedicatedTenancyModificationStateEnumFailed = "FAILED"
)
View Source 
const (
	// DedicatedTenancySupportResultEnumEnabled is a DedicatedTenancySupportResultEnum enum value
	DedicatedTenancySupportResultEnumEnabled = "ENABLED"

	// DedicatedTenancySupportResultEnumDisabled is a DedicatedTenancySupportResultEnum enum value
	DedicatedTenancySupportResultEnumDisabled = "DISABLED"
)
View Source 
const (
	// DeletableSamlPropertySamlPropertiesUserAccessUrl is a DeletableSamlProperty enum value
	DeletableSamlPropertySamlPropertiesUserAccessUrl = "SAML_PROPERTIES_USER_ACCESS_URL"

	// DeletableSamlPropertySamlPropertiesRelayStateParameterName is a DeletableSamlProperty enum value
	DeletableSamlPropertySamlPropertiesRelayStateParameterName = "SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME"
)
View Source 
const (
	// ImageTypeOwned is a ImageType enum value
	ImageTypeOwned = "OWNED"

	// ImageTypeShared is a ImageType enum value
	ImageTypeShared = "SHARED"
)
View Source 
const (
	// LogUploadEnumEnabled is a LogUploadEnum enum value
	LogUploadEnumEnabled = "ENABLED"

	// LogUploadEnumDisabled is a LogUploadEnum enum value
	LogUploadEnumDisabled = "DISABLED"
)
View Source 
const (
	// ModificationResourceEnumRootVolume is a ModificationResourceEnum enum value
	ModificationResourceEnumRootVolume = "ROOT_VOLUME"

	// ModificationResourceEnumUserVolume is a ModificationResourceEnum enum value
	ModificationResourceEnumUserVolume = "USER_VOLUME"

	// ModificationResourceEnumComputeType is a ModificationResourceEnum enum value
	ModificationResourceEnumComputeType = "COMPUTE_TYPE"
)
View Source 
const (
	// ModificationStateEnumUpdateInitiated is a ModificationStateEnum enum value
	ModificationStateEnumUpdateInitiated = "UPDATE_INITIATED"

	// ModificationStateEnumUpdateInProgress is a ModificationStateEnum enum value
	ModificationStateEnumUpdateInProgress = "UPDATE_IN_PROGRESS"
)
View Source 
const (
	// OperatingSystemNameAmazonLinux2 is a OperatingSystemName enum value
	OperatingSystemNameAmazonLinux2 = "AMAZON_LINUX_2"

	// OperatingSystemNameUbuntu1804 is a OperatingSystemName enum value
	OperatingSystemNameUbuntu1804 = "UBUNTU_18_04"

	// OperatingSystemNameUbuntu2004 is a OperatingSystemName enum value
	OperatingSystemNameUbuntu2004 = "UBUNTU_20_04"

	// OperatingSystemNameUbuntu2204 is a OperatingSystemName enum value
	OperatingSystemNameUbuntu2204 = "UBUNTU_22_04"

	// OperatingSystemNameUnknown is a OperatingSystemName enum value
	OperatingSystemNameUnknown = "UNKNOWN"

	// OperatingSystemNameWindows10 is a OperatingSystemName enum value
	OperatingSystemNameWindows10 = "WINDOWS_10"

	// OperatingSystemNameWindows11 is a OperatingSystemName enum value
	OperatingSystemNameWindows11 = "WINDOWS_11"

	// OperatingSystemNameWindows7 is a OperatingSystemName enum value
	OperatingSystemNameWindows7 = "WINDOWS_7"

	// OperatingSystemNameWindowsServer2016 is a OperatingSystemName enum value
	OperatingSystemNameWindowsServer2016 = "WINDOWS_SERVER_2016"

	// OperatingSystemNameWindowsServer2019 is a OperatingSystemName enum value
	OperatingSystemNameWindowsServer2019 = "WINDOWS_SERVER_2019"

	// OperatingSystemNameWindowsServer2022 is a OperatingSystemName enum value
	OperatingSystemNameWindowsServer2022 = "WINDOWS_SERVER_2022"
)
View Source 
const (
	// OperatingSystemTypeWindows is a OperatingSystemType enum value
	OperatingSystemTypeWindows = "WINDOWS"

	// OperatingSystemTypeLinux is a OperatingSystemType enum value
	OperatingSystemTypeLinux = "LINUX"
)
View Source 
const (
	// ProtocolPcoip is a Protocol enum value
	ProtocolPcoip = "PCOIP"

	// ProtocolWsp is a Protocol enum value
	ProtocolWsp = "WSP"
)
View Source 
const (
	// ReconnectEnumEnabled is a ReconnectEnum enum value
	ReconnectEnumEnabled = "ENABLED"

	// ReconnectEnumDisabled is a ReconnectEnum enum value
	ReconnectEnumDisabled = "DISABLED"
)
View Source 
const (
	// RunningModeAutoStop is a RunningMode enum value
	RunningModeAutoStop = "AUTO_STOP"

	// RunningModeAlwaysOn is a RunningMode enum value
	RunningModeAlwaysOn = "ALWAYS_ON"

	// RunningModeManual is a RunningMode enum value
	RunningModeManual = "MANUAL"
)
View Source 
const (
	// SamlStatusEnumDisabled is a SamlStatusEnum enum value
	SamlStatusEnumDisabled = "DISABLED"

	// SamlStatusEnumEnabled is a SamlStatusEnum enum value
	SamlStatusEnumEnabled = "ENABLED"

	// SamlStatusEnumEnabledWithDirectoryLoginFallback is a SamlStatusEnum enum value
	SamlStatusEnumEnabledWithDirectoryLoginFallback = "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK"
)
View Source 
const (
	// StandbyWorkspaceRelationshipTypePrimary is a StandbyWorkspaceRelationshipType enum value
	StandbyWorkspaceRelationshipTypePrimary = "PRIMARY"

	// StandbyWorkspaceRelationshipTypeStandby is a StandbyWorkspaceRelationshipType enum value
	StandbyWorkspaceRelationshipTypeStandby = "STANDBY"
)
View Source 
const (
	// TargetWorkspaceStateAvailable is a TargetWorkspaceState enum value
	TargetWorkspaceStateAvailable = "AVAILABLE"

	// TargetWorkspaceStateAdminMaintenance is a TargetWorkspaceState enum value
	TargetWorkspaceStateAdminMaintenance = "ADMIN_MAINTENANCE"
)
View Source 
const (
	// TenancyDedicated is a Tenancy enum value
	TenancyDedicated = "DEDICATED"

	// TenancyShared is a Tenancy enum value
	TenancyShared = "SHARED"
)
View Source 
const (
	// WorkSpaceApplicationLicenseTypeLicensed is a WorkSpaceApplicationLicenseType enum value
	WorkSpaceApplicationLicenseTypeLicensed = "LICENSED"

	// WorkSpaceApplicationLicenseTypeUnlicensed is a WorkSpaceApplicationLicenseType enum value
	WorkSpaceApplicationLicenseTypeUnlicensed = "UNLICENSED"
)
View Source 
const (
	// WorkSpaceApplicationStatePending is a WorkSpaceApplicationState enum value
	WorkSpaceApplicationStatePending = "PENDING"

	// WorkSpaceApplicationStateError is a WorkSpaceApplicationState enum value
	WorkSpaceApplicationStateError = "ERROR"

	// WorkSpaceApplicationStateAvailable is a WorkSpaceApplicationState enum value
	WorkSpaceApplicationStateAvailable = "AVAILABLE"

	// WorkSpaceApplicationStateUninstallOnly is a WorkSpaceApplicationState enum value
	WorkSpaceApplicationStateUninstallOnly = "UNINSTALL_ONLY"
)
View Source 
const (
	// WorkspaceBundleStateAvailable is a WorkspaceBundleState enum value
	WorkspaceBundleStateAvailable = "AVAILABLE"

	// WorkspaceBundleStatePending is a WorkspaceBundleState enum value
	WorkspaceBundleStatePending = "PENDING"

	// WorkspaceBundleStateError is a WorkspaceBundleState enum value
	WorkspaceBundleStateError = "ERROR"
)
View Source 
const (
	// WorkspaceDirectoryStateRegistering is a WorkspaceDirectoryState enum value
	WorkspaceDirectoryStateRegistering = "REGISTERING"

	// WorkspaceDirectoryStateRegistered is a WorkspaceDirectoryState enum value
	WorkspaceDirectoryStateRegistered = "REGISTERED"

	// WorkspaceDirectoryStateDeregistering is a WorkspaceDirectoryState enum value
	WorkspaceDirectoryStateDeregistering = "DEREGISTERING"

	// WorkspaceDirectoryStateDeregistered is a WorkspaceDirectoryState enum value
	WorkspaceDirectoryStateDeregistered = "DEREGISTERED"

	// WorkspaceDirectoryStateError is a WorkspaceDirectoryState enum value
	WorkspaceDirectoryStateError = "ERROR"
)
View Source 
const (
	// WorkspaceDirectoryTypeSimpleAd is a WorkspaceDirectoryType enum value
	WorkspaceDirectoryTypeSimpleAd = "SIMPLE_AD"

	// WorkspaceDirectoryTypeAdConnector is a WorkspaceDirectoryType enum value
	WorkspaceDirectoryTypeAdConnector = "AD_CONNECTOR"
)
View Source 
const (
	// WorkspaceImageErrorDetailCodeOutdatedPowershellVersion is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeOutdatedPowershellVersion = "OutdatedPowershellVersion"

	// WorkspaceImageErrorDetailCodeOfficeInstalled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeOfficeInstalled = "OfficeInstalled"

	// WorkspaceImageErrorDetailCodePcoIpagentInstalled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodePcoIpagentInstalled = "PCoIPAgentInstalled"

	// WorkspaceImageErrorDetailCodeWindowsUpdatesEnabled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeWindowsUpdatesEnabled = "WindowsUpdatesEnabled"

	// WorkspaceImageErrorDetailCodeAutoMountDisabled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeAutoMountDisabled = "AutoMountDisabled"

	// WorkspaceImageErrorDetailCodeWorkspacesByolaccountNotFound is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeWorkspacesByolaccountNotFound = "WorkspacesBYOLAccountNotFound"

	// WorkspaceImageErrorDetailCodeWorkspacesByolaccountDisabled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeWorkspacesByolaccountDisabled = "WorkspacesBYOLAccountDisabled"

	// WorkspaceImageErrorDetailCodeDhcpdisabled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeDhcpdisabled = "DHCPDisabled"

	// WorkspaceImageErrorDetailCodeDiskFreeSpace is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeDiskFreeSpace = "DiskFreeSpace"

	// WorkspaceImageErrorDetailCodeAdditionalDrivesAttached is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeAdditionalDrivesAttached = "AdditionalDrivesAttached"

	// WorkspaceImageErrorDetailCodeOsnotSupported is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeOsnotSupported = "OSNotSupported"

	// WorkspaceImageErrorDetailCodeDomainJoined is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeDomainJoined = "DomainJoined"

	// WorkspaceImageErrorDetailCodeAzureDomainJoined is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeAzureDomainJoined = "AzureDomainJoined"

	// WorkspaceImageErrorDetailCodeFirewallEnabled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeFirewallEnabled = "FirewallEnabled"

	// WorkspaceImageErrorDetailCodeVmwareToolsInstalled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeVmwareToolsInstalled = "VMWareToolsInstalled"

	// WorkspaceImageErrorDetailCodeDiskSizeExceeded is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeDiskSizeExceeded = "DiskSizeExceeded"

	// WorkspaceImageErrorDetailCodeIncompatiblePartitioning is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeIncompatiblePartitioning = "IncompatiblePartitioning"

	// WorkspaceImageErrorDetailCodePendingReboot is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodePendingReboot = "PendingReboot"

	// WorkspaceImageErrorDetailCodeAutoLogonEnabled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeAutoLogonEnabled = "AutoLogonEnabled"

	// WorkspaceImageErrorDetailCodeRealTimeUniversalDisabled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeRealTimeUniversalDisabled = "RealTimeUniversalDisabled"

	// WorkspaceImageErrorDetailCodeMultipleBootPartition is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeMultipleBootPartition = "MultipleBootPartition"

	// WorkspaceImageErrorDetailCodeRequires64bitOs is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeRequires64bitOs = "Requires64BitOS"

	// WorkspaceImageErrorDetailCodeZeroRearmCount is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeZeroRearmCount = "ZeroRearmCount"

	// WorkspaceImageErrorDetailCodeInPlaceUpgrade is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeInPlaceUpgrade = "InPlaceUpgrade"

	// WorkspaceImageErrorDetailCodeAntiVirusInstalled is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeAntiVirusInstalled = "AntiVirusInstalled"

	// WorkspaceImageErrorDetailCodeUefinotSupported is a WorkspaceImageErrorDetailCode enum value
	WorkspaceImageErrorDetailCodeUefinotSupported = "UEFINotSupported"
)
View Source 
const (
	// WorkspaceImageIngestionProcessByolRegular is a WorkspaceImageIngestionProcess enum value
	WorkspaceImageIngestionProcessByolRegular = "BYOL_REGULAR"

	// WorkspaceImageIngestionProcessByolGraphics is a WorkspaceImageIngestionProcess enum value
	WorkspaceImageIngestionProcessByolGraphics = "BYOL_GRAPHICS"

	// WorkspaceImageIngestionProcessByolGraphicspro is a WorkspaceImageIngestionProcess enum value
	WorkspaceImageIngestionProcessByolGraphicspro = "BYOL_GRAPHICSPRO"

	// WorkspaceImageIngestionProcessByolGraphicsG4dn is a WorkspaceImageIngestionProcess enum value
	WorkspaceImageIngestionProcessByolGraphicsG4dn = "BYOL_GRAPHICS_G4DN"

	// WorkspaceImageIngestionProcessByolRegularWsp is a WorkspaceImageIngestionProcess enum value
	WorkspaceImageIngestionProcessByolRegularWsp = "BYOL_REGULAR_WSP"

	// WorkspaceImageIngestionProcessByolRegularByop is a WorkspaceImageIngestionProcess enum value
	WorkspaceImageIngestionProcessByolRegularByop = "BYOL_REGULAR_BYOP"

	// WorkspaceImageIngestionProcessByolGraphicsG4dnByop is a WorkspaceImageIngestionProcess enum value
	WorkspaceImageIngestionProcessByolGraphicsG4dnByop = "BYOL_GRAPHICS_G4DN_BYOP"
)
View Source 
const (
	// WorkspaceImageRequiredTenancyDefault is a WorkspaceImageRequiredTenancy enum value
	WorkspaceImageRequiredTenancyDefault = "DEFAULT"

	// WorkspaceImageRequiredTenancyDedicated is a WorkspaceImageRequiredTenancy enum value
	WorkspaceImageRequiredTenancyDedicated = "DEDICATED"
)
View Source 
const (
	// WorkspaceImageStateAvailable is a WorkspaceImageState enum value
	WorkspaceImageStateAvailable = "AVAILABLE"

	// WorkspaceImageStatePending is a WorkspaceImageState enum value
	WorkspaceImageStatePending = "PENDING"

	// WorkspaceImageStateError is a WorkspaceImageState enum value
	WorkspaceImageStateError = "ERROR"
)
View Source 
const (
	// WorkspaceStatePending is a WorkspaceState enum value
	WorkspaceStatePending = "PENDING"

	// WorkspaceStateAvailable is a WorkspaceState enum value
	WorkspaceStateAvailable = "AVAILABLE"

	// WorkspaceStateImpaired is a WorkspaceState enum value
	WorkspaceStateImpaired = "IMPAIRED"

	// WorkspaceStateUnhealthy is a WorkspaceState enum value
	WorkspaceStateUnhealthy = "UNHEALTHY"

	// WorkspaceStateRebooting is a WorkspaceState enum value
	WorkspaceStateRebooting = "REBOOTING"

	// WorkspaceStateStarting is a WorkspaceState enum value
	WorkspaceStateStarting = "STARTING"

	// WorkspaceStateRebuilding is a WorkspaceState enum value
	WorkspaceStateRebuilding = "REBUILDING"

	// WorkspaceStateRestoring is a WorkspaceState enum value
	WorkspaceStateRestoring = "RESTORING"

	// WorkspaceStateMaintenance is a WorkspaceState enum value
	WorkspaceStateMaintenance = "MAINTENANCE"

	// WorkspaceStateAdminMaintenance is a WorkspaceState enum value
	WorkspaceStateAdminMaintenance = "ADMIN_MAINTENANCE"

	// WorkspaceStateTerminating is a WorkspaceState enum value
	WorkspaceStateTerminating = "TERMINATING"

	// WorkspaceStateTerminated is a WorkspaceState enum value
	WorkspaceStateTerminated = "TERMINATED"

	// WorkspaceStateSuspended is a WorkspaceState enum value
	WorkspaceStateSuspended = "SUSPENDED"

	// WorkspaceStateUpdating is a WorkspaceState enum value
	WorkspaceStateUpdating = "UPDATING"

	// WorkspaceStateStopping is a WorkspaceState enum value
	WorkspaceStateStopping = "STOPPING"

	// WorkspaceStateStopped is a WorkspaceState enum value
	WorkspaceStateStopped = "STOPPED"

	// WorkspaceStateError is a WorkspaceState enum value
	WorkspaceStateError = "ERROR"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// The user is not authorized to access a resource.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeApplicationNotSupportedException for service response error code
	// "ApplicationNotSupportedException".
	//
	// The specified application is not supported.
	ErrCodeApplicationNotSupportedException = "ApplicationNotSupportedException"

	// ErrCodeComputeNotCompatibleException for service response error code
	// "ComputeNotCompatibleException".
	//
	// The compute type of the WorkSpace is not compatible with the application.
	ErrCodeComputeNotCompatibleException = "ComputeNotCompatibleException"

	// ErrCodeIncompatibleApplicationsException for service response error code
	// "IncompatibleApplicationsException".
	//
	// The specified application is not compatible with the resource.
	ErrCodeIncompatibleApplicationsException = "IncompatibleApplicationsException"

	// ErrCodeInvalidParameterValuesException for service response error code
	// "InvalidParameterValuesException".
	//
	// One or more parameter values are not valid.
	ErrCodeInvalidParameterValuesException = "InvalidParameterValuesException"

	// ErrCodeInvalidResourceStateException for service response error code
	// "InvalidResourceStateException".
	//
	// The state of the resource is not valid for this operation.
	ErrCodeInvalidResourceStateException = "InvalidResourceStateException"

	// ErrCodeOperatingSystemNotCompatibleException for service response error code
	// "OperatingSystemNotCompatibleException".
	//
	// The operating system of the WorkSpace is not compatible with the application.
	ErrCodeOperatingSystemNotCompatibleException = "OperatingSystemNotCompatibleException"

	// ErrCodeOperationInProgressException for service response error code
	// "OperationInProgressException".
	//
	// The properties of this WorkSpace are currently being modified. Try again
	// in a moment.
	ErrCodeOperationInProgressException = "OperationInProgressException"

	// ErrCodeOperationNotSupportedException for service response error code
	// "OperationNotSupportedException".
	//
	// This operation is not supported.
	ErrCodeOperationNotSupportedException = "OperationNotSupportedException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The specified resource already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceAssociatedException for service response error code
	// "ResourceAssociatedException".
	//
	// The resource is associated with a directory.
	ErrCodeResourceAssociatedException = "ResourceAssociatedException"

	// ErrCodeResourceCreationFailedException for service response error code
	// "ResourceCreationFailedException".
	//
	// The resource could not be created.
	ErrCodeResourceCreationFailedException = "ResourceCreationFailedException"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The specified resource is currently in use.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceLimitExceededException for service response error code
	// "ResourceLimitExceededException".
	//
	// Your resource limits have been exceeded.
	ErrCodeResourceLimitExceededException = "ResourceLimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource could not be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceUnavailableException for service response error code
	// "ResourceUnavailableException".
	//
	// The specified resource is not available.
	ErrCodeResourceUnavailableException = "ResourceUnavailableException"

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

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

	// ErrCodeWorkspacesDefaultRoleNotFoundException for service response error code
	// "WorkspacesDefaultRoleNotFoundException".
	//
	// The workspaces_DefaultRole role could not be found. If this is the first
	// time you are registering a directory, you will need to create the workspaces_DefaultRole
	// role before you can register a directory. For more information, see Creating
	// the workspaces_DefaultRole Role (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role).
	ErrCodeWorkspacesDefaultRoleNotFoundException = "WorkspacesDefaultRoleNotFoundException"
)
View Source 
const (
	ServiceName = "workspaces" // Name of service.
	EndpointsID = ServiceName  // ID to lookup a service endpoint with.
	ServiceID   = "WorkSpaces" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// BundleAssociatedResourceTypeApplication is a BundleAssociatedResourceType enum value
	BundleAssociatedResourceTypeApplication = "APPLICATION"
)
View Source 
const (
	// DedicatedTenancySupportEnumEnabled is a DedicatedTenancySupportEnum enum value
	DedicatedTenancySupportEnumEnabled = "ENABLED"
)
View Source 
const (
	// DeletableCertificateBasedAuthPropertyCertificateBasedAuthPropertiesCertificateAuthorityArn is a DeletableCertificateBasedAuthProperty enum value
	DeletableCertificateBasedAuthPropertyCertificateBasedAuthPropertiesCertificateAuthorityArn = "CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN"
)
View Source 
const (
	// ImageAssociatedResourceTypeApplication is a ImageAssociatedResourceType enum value
	ImageAssociatedResourceTypeApplication = "APPLICATION"
)
View Source 
const (
	// WorkSpaceAssociatedResourceTypeApplication is a WorkSpaceAssociatedResourceType enum value
	WorkSpaceAssociatedResourceTypeApplication = "APPLICATION"
)

Variables

This section is empty.

Functions

func AccessPropertyValue_Values added in v1.34.3 

func AccessPropertyValue_Values() []string

AccessPropertyValue_Values returns all elements of the AccessPropertyValue enum

func ApplicationAssociatedResourceType_Values added in v1.45.23 

func ApplicationAssociatedResourceType_Values() []string

ApplicationAssociatedResourceType_Values returns all elements of the ApplicationAssociatedResourceType enum

func Application_Values added in v1.34.18 

func Application_Values() []string

Application_Values returns all elements of the Application enum

func AssociationErrorCode_Values added in v1.45.23 

func AssociationErrorCode_Values() []string

AssociationErrorCode_Values returns all elements of the AssociationErrorCode enum

func AssociationState_Values added in v1.45.23 

func AssociationState_Values() []string

AssociationState_Values returns all elements of the AssociationState enum

func AssociationStatus_Values added in v1.34.22 

func AssociationStatus_Values() []string

AssociationStatus_Values returns all elements of the AssociationStatus enum

func BundleAssociatedResourceType_Values added in v1.45.23 

func BundleAssociatedResourceType_Values() []string

BundleAssociatedResourceType_Values returns all elements of the BundleAssociatedResourceType enum

func BundleType_Values added in v1.44.140 

func BundleType_Values() []string

BundleType_Values returns all elements of the BundleType enum

func CertificateBasedAuthStatusEnum_Values added in v1.44.138 

func CertificateBasedAuthStatusEnum_Values() []string

CertificateBasedAuthStatusEnum_Values returns all elements of the CertificateBasedAuthStatusEnum enum

func ClientDeviceType_Values added in v1.43.30 

func ClientDeviceType_Values() []string

ClientDeviceType_Values returns all elements of the ClientDeviceType enum

func Compute_Values added in v1.34.3 

func Compute_Values() []string

Compute_Values returns all elements of the Compute enum

func ConnectionAliasState_Values added in v1.34.22 

func ConnectionAliasState_Values() []string

ConnectionAliasState_Values returns all elements of the ConnectionAliasState enum

func ConnectionState_Values added in v1.34.3 

func ConnectionState_Values() []string

ConnectionState_Values returns all elements of the ConnectionState enum

func DataReplication_Values added in v1.48.4 

func DataReplication_Values() []string

DataReplication_Values returns all elements of the DataReplication enum

func DedicatedTenancyModificationStateEnum_Values added in v1.34.3 

func DedicatedTenancyModificationStateEnum_Values() []string

DedicatedTenancyModificationStateEnum_Values returns all elements of the DedicatedTenancyModificationStateEnum enum

func DedicatedTenancySupportEnum_Values added in v1.34.3 

func DedicatedTenancySupportEnum_Values() []string

DedicatedTenancySupportEnum_Values returns all elements of the DedicatedTenancySupportEnum enum

func DedicatedTenancySupportResultEnum_Values added in v1.34.3 

func DedicatedTenancySupportResultEnum_Values() []string

DedicatedTenancySupportResultEnum_Values returns all elements of the DedicatedTenancySupportResultEnum enum

func DeletableCertificateBasedAuthProperty_Values added in v1.44.138 

func DeletableCertificateBasedAuthProperty_Values() []string

DeletableCertificateBasedAuthProperty_Values returns all elements of the DeletableCertificateBasedAuthProperty enum

func DeletableSamlProperty_Values added in v1.44.67 

func DeletableSamlProperty_Values() []string

DeletableSamlProperty_Values returns all elements of the DeletableSamlProperty enum

func ImageAssociatedResourceType_Values added in v1.45.23 

func ImageAssociatedResourceType_Values() []string

ImageAssociatedResourceType_Values returns all elements of the ImageAssociatedResourceType enum

func ImageType_Values added in v1.34.3 

func ImageType_Values() []string

ImageType_Values returns all elements of the ImageType enum

func LogUploadEnum_Values added in v1.44.108 

func LogUploadEnum_Values() []string

LogUploadEnum_Values returns all elements of the LogUploadEnum enum

func ModificationResourceEnum_Values added in v1.34.3 

func ModificationResourceEnum_Values() []string

ModificationResourceEnum_Values returns all elements of the ModificationResourceEnum enum

func ModificationStateEnum_Values added in v1.34.3 

func ModificationStateEnum_Values() []string

ModificationStateEnum_Values returns all elements of the ModificationStateEnum enum

func OperatingSystemName_Values added in v1.45.23 

func OperatingSystemName_Values() []string

OperatingSystemName_Values returns all elements of the OperatingSystemName enum

func OperatingSystemType_Values added in v1.34.3 

func OperatingSystemType_Values() []string

OperatingSystemType_Values returns all elements of the OperatingSystemType enum

func Protocol_Values added in v1.44.132 

func Protocol_Values() []string

Protocol_Values returns all elements of the Protocol enum

func ReconnectEnum_Values added in v1.34.3 

func ReconnectEnum_Values() []string

ReconnectEnum_Values returns all elements of the ReconnectEnum enum

func RunningMode_Values added in v1.34.3 

func RunningMode_Values() []string

RunningMode_Values returns all elements of the RunningMode enum

func SamlStatusEnum_Values added in v1.44.67 

func SamlStatusEnum_Values() []string

SamlStatusEnum_Values returns all elements of the SamlStatusEnum enum

func StandbyWorkspaceRelationshipType_Values added in v1.44.140 

func StandbyWorkspaceRelationshipType_Values() []string

StandbyWorkspaceRelationshipType_Values returns all elements of the StandbyWorkspaceRelationshipType enum

func TargetWorkspaceState_Values added in v1.34.3 

func TargetWorkspaceState_Values() []string

TargetWorkspaceState_Values returns all elements of the TargetWorkspaceState enum

func Tenancy_Values added in v1.34.3 

func Tenancy_Values() []string

Tenancy_Values returns all elements of the Tenancy enum

func WorkSpaceApplicationLicenseType_Values added in v1.45.23 

func WorkSpaceApplicationLicenseType_Values() []string

WorkSpaceApplicationLicenseType_Values returns all elements of the WorkSpaceApplicationLicenseType enum

func WorkSpaceApplicationState_Values added in v1.45.23 

func WorkSpaceApplicationState_Values() []string

WorkSpaceApplicationState_Values returns all elements of the WorkSpaceApplicationState enum

func WorkSpaceAssociatedResourceType_Values added in v1.45.23 

func WorkSpaceAssociatedResourceType_Values() []string

WorkSpaceAssociatedResourceType_Values returns all elements of the WorkSpaceAssociatedResourceType enum

func WorkspaceBundleState_Values added in v1.44.140 

func WorkspaceBundleState_Values() []string

WorkspaceBundleState_Values returns all elements of the WorkspaceBundleState enum

func WorkspaceDirectoryState_Values added in v1.34.3 

func WorkspaceDirectoryState_Values() []string

WorkspaceDirectoryState_Values returns all elements of the WorkspaceDirectoryState enum

func WorkspaceDirectoryType_Values added in v1.34.3 

func WorkspaceDirectoryType_Values() []string

WorkspaceDirectoryType_Values returns all elements of the WorkspaceDirectoryType enum

func WorkspaceImageErrorDetailCode_Values added in v1.45.6 

func WorkspaceImageErrorDetailCode_Values() []string

WorkspaceImageErrorDetailCode_Values returns all elements of the WorkspaceImageErrorDetailCode enum

func WorkspaceImageIngestionProcess_Values added in v1.34.3 

func WorkspaceImageIngestionProcess_Values() []string

WorkspaceImageIngestionProcess_Values returns all elements of the WorkspaceImageIngestionProcess enum

func WorkspaceImageRequiredTenancy_Values added in v1.34.3 

func WorkspaceImageRequiredTenancy_Values() []string

WorkspaceImageRequiredTenancy_Values returns all elements of the WorkspaceImageRequiredTenancy enum

func WorkspaceImageState_Values added in v1.34.3 

func WorkspaceImageState_Values() []string

WorkspaceImageState_Values returns all elements of the WorkspaceImageState enum

func WorkspaceState_Values added in v1.34.3 

func WorkspaceState_Values() []string

WorkspaceState_Values returns all elements of the WorkspaceState enum

Types

type AccessDeniedException added in v1.28.0 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The user is not authorized to access a resource.

func (*AccessDeniedException) Code added in v1.28.0 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.28.0 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.28.0 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.28.0 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.28.0 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.28.0 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.28.0 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.28.0 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AccountModification added in v1.15.78 

type AccountModification struct {

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

	// The status of BYOL (whether BYOL is being enabled or disabled).
	DedicatedTenancySupport *string `type:"string" enum:"DedicatedTenancySupportResultEnum"`

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

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

	// The state of the modification to the configuration of BYOL.
	ModificationState *string `type:"string" enum:"DedicatedTenancyModificationStateEnum"`

	// The timestamp when the modification of the BYOL configuration was started.
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

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

func (AccountModification) GoString added in v1.15.78 

func (s AccountModification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountModification) SetDedicatedTenancyManagementCidrRange added in v1.15.78 

func (s *AccountModification) SetDedicatedTenancyManagementCidrRange(v string) *AccountModification

SetDedicatedTenancyManagementCidrRange sets the DedicatedTenancyManagementCidrRange field's value.

func (*AccountModification) SetDedicatedTenancySupport added in v1.15.78 

func (s *AccountModification) SetDedicatedTenancySupport(v string) *AccountModification

SetDedicatedTenancySupport sets the DedicatedTenancySupport field's value.

func (*AccountModification) SetErrorCode added in v1.15.78 

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

SetErrorCode sets the ErrorCode field's value.

func (*AccountModification) SetErrorMessage added in v1.15.78 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*AccountModification) SetModificationState added in v1.15.78 

func (s *AccountModification) SetModificationState(v string) *AccountModification

SetModificationState sets the ModificationState field's value.

func (*AccountModification) SetStartTime added in v1.15.78 

func (s *AccountModification) SetStartTime(v time.Time) *AccountModification

SetStartTime sets the StartTime field's value.

func (AccountModification) String added in v1.15.78 

func (s AccountModification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApplicationNotSupportedException added in v1.45.23 

type ApplicationNotSupportedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified application is not supported.

func (*ApplicationNotSupportedException) Code added in v1.45.23 

func (s *ApplicationNotSupportedException) Code() string

Code returns the exception type name.

func (*ApplicationNotSupportedException) Error added in v1.45.23 

func (s *ApplicationNotSupportedException) Error() string

func (ApplicationNotSupportedException) GoString added in v1.45.23 

func (s ApplicationNotSupportedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplicationNotSupportedException) Message added in v1.45.23 

func (s *ApplicationNotSupportedException) Message() string

Message returns the exception's message.

func (*ApplicationNotSupportedException) OrigErr added in v1.45.23 

func (s *ApplicationNotSupportedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ApplicationNotSupportedException) RequestID added in v1.45.23 

func (s *ApplicationNotSupportedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ApplicationNotSupportedException) StatusCode added in v1.45.23 

func (s *ApplicationNotSupportedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ApplicationNotSupportedException) String added in v1.45.23 

func (s ApplicationNotSupportedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ApplicationResourceAssociation added in v1.45.23 

type ApplicationResourceAssociation struct {

	// The identifier of the application.
	ApplicationId *string `type:"string"`

	// The identifier of the associated resource.
	AssociatedResourceId *string `min:"1" type:"string"`

	// The resource type of the associated resource.
	AssociatedResourceType *string `type:"string" enum:"ApplicationAssociatedResourceType"`

	// The time the association was created.
	Created *time.Time `type:"timestamp"`

	// The time the association status was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// The status of the application resource association.
	State *string `type:"string" enum:"AssociationState"`

	// The reason the association deployment failed.
	StateReason *AssociationStateReason `type:"structure"`
	// contains filtered or unexported fields
}

Describes the association between an application and an application resource.

func (ApplicationResourceAssociation) GoString added in v1.45.23 

func (s ApplicationResourceAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ApplicationResourceAssociation) SetApplicationId added in v1.45.23 

func (s *ApplicationResourceAssociation) SetApplicationId(v string) *ApplicationResourceAssociation

SetApplicationId sets the ApplicationId field's value.

func (*ApplicationResourceAssociation) SetAssociatedResourceId added in v1.45.23 

func (s *ApplicationResourceAssociation) SetAssociatedResourceId(v string) *ApplicationResourceAssociation

SetAssociatedResourceId sets the AssociatedResourceId field's value.

func (*ApplicationResourceAssociation) SetAssociatedResourceType added in v1.45.23 

func (s *ApplicationResourceAssociation) SetAssociatedResourceType(v string) *ApplicationResourceAssociation

SetAssociatedResourceType sets the AssociatedResourceType field's value.

func (*ApplicationResourceAssociation) SetCreated added in v1.45.23 

func (s *ApplicationResourceAssociation) SetCreated(v time.Time) *ApplicationResourceAssociation

SetCreated sets the Created field's value.

func (*ApplicationResourceAssociation) SetLastUpdatedTime added in v1.45.23 

func (s *ApplicationResourceAssociation) SetLastUpdatedTime(v time.Time) *ApplicationResourceAssociation

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*ApplicationResourceAssociation) SetState added in v1.45.23 

func (s *ApplicationResourceAssociation) SetState(v string) *ApplicationResourceAssociation

SetState sets the State field's value.

func (*ApplicationResourceAssociation) SetStateReason added in v1.45.23 

func (s *ApplicationResourceAssociation) SetStateReason(v *AssociationStateReason) *ApplicationResourceAssociation

SetStateReason sets the StateReason field's value.

func (ApplicationResourceAssociation) String added in v1.45.23 

func (s ApplicationResourceAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateConnectionAliasInput added in v1.34.22 

type AssociateConnectionAliasInput struct {

	// The identifier of the connection alias.
	//
	// AliasId is a required field
	AliasId *string `min:"13" type:"string" required:"true"`

	// The identifier of the directory to associate the connection alias with.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateConnectionAliasInput) GoString added in v1.34.22 

func (s AssociateConnectionAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateConnectionAliasInput) SetAliasId added in v1.34.22 

func (s *AssociateConnectionAliasInput) SetAliasId(v string) *AssociateConnectionAliasInput

SetAliasId sets the AliasId field's value.

func (*AssociateConnectionAliasInput) SetResourceId added in v1.34.22 

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

SetResourceId sets the ResourceId field's value.

func (AssociateConnectionAliasInput) String added in v1.34.22 

func (s AssociateConnectionAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateConnectionAliasInput) Validate added in v1.34.22 

func (s *AssociateConnectionAliasInput) Validate() error

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

type AssociateConnectionAliasOutput added in v1.34.22 

type AssociateConnectionAliasOutput struct {

	// 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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateConnectionAliasOutput) GoString added in v1.34.22 

func (s AssociateConnectionAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateConnectionAliasOutput) SetConnectionIdentifier added in v1.34.22 

func (s *AssociateConnectionAliasOutput) SetConnectionIdentifier(v string) *AssociateConnectionAliasOutput

SetConnectionIdentifier sets the ConnectionIdentifier field's value.

func (AssociateConnectionAliasOutput) String added in v1.34.22 

func (s AssociateConnectionAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateIpGroupsInput added in v1.13.39 

type AssociateIpGroupsInput struct {

	// The identifier of the directory.
	//
	// DirectoryId is a required field
	DirectoryId *string `min:"10" type:"string" required:"true"`

	// The identifiers of one or more IP access control groups.
	//
	// GroupIds is a required field
	GroupIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateIpGroupsInput) GoString added in v1.13.39 

func (s AssociateIpGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateIpGroupsInput) SetDirectoryId added in v1.13.39 

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

SetDirectoryId sets the DirectoryId field's value.

func (*AssociateIpGroupsInput) SetGroupIds added in v1.13.39 

func (s *AssociateIpGroupsInput) SetGroupIds(v []*string) *AssociateIpGroupsInput

SetGroupIds sets the GroupIds field's value.

func (AssociateIpGroupsInput) String added in v1.13.39 

func (s AssociateIpGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateIpGroupsInput) Validate added in v1.13.39 

func (s *AssociateIpGroupsInput) Validate() error

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

type AssociateIpGroupsOutput added in v1.13.39 

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

func (AssociateIpGroupsOutput) GoString added in v1.13.39 

func (s AssociateIpGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AssociateIpGroupsOutput) String added in v1.13.39 

func (s AssociateIpGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateWorkspaceApplicationInput added in v1.45.23 

type AssociateWorkspaceApplicationInput struct {

	// The identifier of the application.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

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

func (AssociateWorkspaceApplicationInput) GoString added in v1.45.23 

func (s AssociateWorkspaceApplicationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateWorkspaceApplicationInput) SetApplicationId added in v1.45.23 

func (s *AssociateWorkspaceApplicationInput) SetApplicationId(v string) *AssociateWorkspaceApplicationInput

SetApplicationId sets the ApplicationId field's value.

func (*AssociateWorkspaceApplicationInput) SetWorkspaceId added in v1.45.23 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (AssociateWorkspaceApplicationInput) String added in v1.45.23 

func (s AssociateWorkspaceApplicationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateWorkspaceApplicationInput) Validate added in v1.45.23 

func (s *AssociateWorkspaceApplicationInput) Validate() error

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

type AssociateWorkspaceApplicationOutput added in v1.45.23 

type AssociateWorkspaceApplicationOutput struct {

	// Information about the association between the specified WorkSpace and the
	// specified application.
	Association *WorkspaceResourceAssociation `type:"structure"`
	// contains filtered or unexported fields
}

func (AssociateWorkspaceApplicationOutput) GoString added in v1.45.23 

func (s AssociateWorkspaceApplicationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateWorkspaceApplicationOutput) SetAssociation added in v1.45.23 

func (s *AssociateWorkspaceApplicationOutput) SetAssociation(v *WorkspaceResourceAssociation) *AssociateWorkspaceApplicationOutput

SetAssociation sets the Association field's value.

func (AssociateWorkspaceApplicationOutput) String added in v1.45.23 

func (s AssociateWorkspaceApplicationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociationStateReason added in v1.45.23 

type AssociationStateReason struct {

	// The error code of the association deployment failure.
	ErrorCode *string `type:"string" enum:"AssociationErrorCode"`

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

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

func (AssociationStateReason) GoString added in v1.45.23 

func (s AssociationStateReason) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociationStateReason) SetErrorCode added in v1.45.23 

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

SetErrorCode sets the ErrorCode field's value.

func (*AssociationStateReason) SetErrorMessage added in v1.45.23 

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

SetErrorMessage sets the ErrorMessage field's value.

func (AssociationStateReason) String added in v1.45.23 

func (s AssociationStateReason) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthorizeIpRulesInput added in v1.13.39 

type AuthorizeIpRulesInput struct {

	// The identifier of the group.
	//
	// GroupId is a required field
	GroupId *string `type:"string" required:"true"`

	// The rules to add to the group.
	//
	// UserRules is a required field
	UserRules []*IpRuleItem `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AuthorizeIpRulesInput) GoString added in v1.13.39 

func (s AuthorizeIpRulesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeIpRulesInput) SetGroupId added in v1.13.39 

func (s *AuthorizeIpRulesInput) SetGroupId(v string) *AuthorizeIpRulesInput

SetGroupId sets the GroupId field's value.

func (*AuthorizeIpRulesInput) SetUserRules added in v1.13.39 

func (s *AuthorizeIpRulesInput) SetUserRules(v []*IpRuleItem) *AuthorizeIpRulesInput

SetUserRules sets the UserRules field's value.

func (AuthorizeIpRulesInput) String added in v1.13.39 

func (s AuthorizeIpRulesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthorizeIpRulesInput) Validate added in v1.13.39 

func (s *AuthorizeIpRulesInput) Validate() error

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

type AuthorizeIpRulesOutput added in v1.13.39 

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

func (AuthorizeIpRulesOutput) GoString added in v1.13.39 

func (s AuthorizeIpRulesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AuthorizeIpRulesOutput) String added in v1.13.39 

func (s AuthorizeIpRulesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BundleResourceAssociation added in v1.45.23 

type BundleResourceAssociation struct {

	// The identifier of the associated resource.
	AssociatedResourceId *string `min:"1" type:"string"`

	// The resource type of the associated resources.
	AssociatedResourceType *string `type:"string" enum:"BundleAssociatedResourceType"`

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

	// The time the association is created.
	Created *time.Time `type:"timestamp"`

	// The time the association status was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// The status of the bundle resource association.
	State *string `type:"string" enum:"AssociationState"`

	// The reason the association deployment failed.
	StateReason *AssociationStateReason `type:"structure"`
	// contains filtered or unexported fields
}

Describes the association between an application and a bundle resource.

func (BundleResourceAssociation) GoString added in v1.45.23 

func (s BundleResourceAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BundleResourceAssociation) SetAssociatedResourceId added in v1.45.23 

func (s *BundleResourceAssociation) SetAssociatedResourceId(v string) *BundleResourceAssociation

SetAssociatedResourceId sets the AssociatedResourceId field's value.

func (*BundleResourceAssociation) SetAssociatedResourceType added in v1.45.23 

func (s *BundleResourceAssociation) SetAssociatedResourceType(v string) *BundleResourceAssociation

SetAssociatedResourceType sets the AssociatedResourceType field's value.

func (*BundleResourceAssociation) SetBundleId added in v1.45.23 

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

SetBundleId sets the BundleId field's value.

func (*BundleResourceAssociation) SetCreated added in v1.45.23 

func (s *BundleResourceAssociation) SetCreated(v time.Time) *BundleResourceAssociation

SetCreated sets the Created field's value.

func (*BundleResourceAssociation) SetLastUpdatedTime added in v1.45.23 

func (s *BundleResourceAssociation) SetLastUpdatedTime(v time.Time) *BundleResourceAssociation

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*BundleResourceAssociation) SetState added in v1.45.23 

func (s *BundleResourceAssociation) SetState(v string) *BundleResourceAssociation

SetState sets the State field's value.

func (*BundleResourceAssociation) SetStateReason added in v1.45.23 

func (s *BundleResourceAssociation) SetStateReason(v *AssociationStateReason) *BundleResourceAssociation

SetStateReason sets the StateReason field's value.

func (BundleResourceAssociation) String added in v1.45.23 

func (s BundleResourceAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CertificateBasedAuthProperties added in v1.44.138 

type CertificateBasedAuthProperties struct {

	// The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager
	// Private CA resource.
	CertificateAuthorityArn *string `min:"5" type:"string"`

	// The status of the certificate-based authentication properties.
	Status *string `type:"string" enum:"CertificateBasedAuthStatusEnum"`
	// contains filtered or unexported fields
}

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

func (CertificateBasedAuthProperties) GoString added in v1.44.138 

func (s CertificateBasedAuthProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateBasedAuthProperties) SetCertificateAuthorityArn added in v1.44.138 

func (s *CertificateBasedAuthProperties) SetCertificateAuthorityArn(v string) *CertificateBasedAuthProperties

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

func (*CertificateBasedAuthProperties) SetStatus added in v1.44.138 

func (s *CertificateBasedAuthProperties) SetStatus(v string) *CertificateBasedAuthProperties

SetStatus sets the Status field's value.

func (CertificateBasedAuthProperties) String added in v1.44.138 

func (s CertificateBasedAuthProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CertificateBasedAuthProperties) Validate added in v1.44.138 

func (s *CertificateBasedAuthProperties) Validate() error

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

type ClientProperties added in v1.15.79 

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 *string `type:"string" enum:"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 *string `type:"string" enum:"ReconnectEnum"`
	// contains filtered or unexported fields
}

Describes an Amazon WorkSpaces client.

func (ClientProperties) GoString added in v1.15.79 

func (s ClientProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClientProperties) SetLogUploadEnabled added in v1.44.108 

func (s *ClientProperties) SetLogUploadEnabled(v string) *ClientProperties

SetLogUploadEnabled sets the LogUploadEnabled field's value.

func (*ClientProperties) SetReconnectEnabled added in v1.15.79 

func (s *ClientProperties) SetReconnectEnabled(v string) *ClientProperties

SetReconnectEnabled sets the ReconnectEnabled field's value.

func (ClientProperties) String added in v1.15.79 

func (s ClientProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClientPropertiesResult added in v1.15.79 

type ClientPropertiesResult struct {

	// Information about the Amazon WorkSpaces client.
	ClientProperties *ClientProperties `type:"structure"`

	// The resource identifier, in the form of a directory ID.
	ResourceId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about the Amazon WorkSpaces client.

func (ClientPropertiesResult) GoString added in v1.15.79 

func (s ClientPropertiesResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClientPropertiesResult) SetClientProperties added in v1.15.79 

func (s *ClientPropertiesResult) SetClientProperties(v *ClientProperties) *ClientPropertiesResult

SetClientProperties sets the ClientProperties field's value.

func (*ClientPropertiesResult) SetResourceId added in v1.15.79 

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

SetResourceId sets the ResourceId field's value.

func (ClientPropertiesResult) String added in v1.15.79 

func (s ClientPropertiesResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComputeNotCompatibleException added in v1.45.23 

type ComputeNotCompatibleException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ComputeNotCompatibleException) Code added in v1.45.23 

func (s *ComputeNotCompatibleException) Code() string

Code returns the exception type name.

func (*ComputeNotCompatibleException) Error added in v1.45.23 

func (s *ComputeNotCompatibleException) Error() string

func (ComputeNotCompatibleException) GoString added in v1.45.23 

func (s ComputeNotCompatibleException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComputeNotCompatibleException) Message added in v1.45.23 

func (s *ComputeNotCompatibleException) Message() string

Message returns the exception's message.

func (*ComputeNotCompatibleException) OrigErr added in v1.45.23 

func (s *ComputeNotCompatibleException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ComputeNotCompatibleException) RequestID added in v1.45.23 

func (s *ComputeNotCompatibleException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ComputeNotCompatibleException) StatusCode added in v1.45.23 

func (s *ComputeNotCompatibleException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ComputeNotCompatibleException) String added in v1.45.23 

func (s ComputeNotCompatibleException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ComputeType 

type ComputeType struct {

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

Describes the compute type of the bundle.

func (ComputeType) GoString added in v0.6.5 

func (s ComputeType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ComputeType) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (ComputeType) String added in v0.6.5 

func (s ComputeType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectClientAddIn added in v1.42.32 

type ConnectClientAddIn struct {

	// The client add-in identifier.
	AddInId *string `min:"36" type:"string"`

	// The name of the client add in.
	Name *string `min:"1" type:"string"`

	// The directory identifier for which the client add-in is configured.
	ResourceId *string `min:"10" type:"string"`

	// The endpoint URL of the client add-in.
	URL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Describes an Amazon Connect client add-in.

func (ConnectClientAddIn) GoString added in v1.42.32 

func (s ConnectClientAddIn) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectClientAddIn) SetAddInId added in v1.42.32 

func (s *ConnectClientAddIn) SetAddInId(v string) *ConnectClientAddIn

SetAddInId sets the AddInId field's value.

func (*ConnectClientAddIn) SetName added in v1.42.32 

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

SetName sets the Name field's value.

func (*ConnectClientAddIn) SetResourceId added in v1.42.32 

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

SetResourceId sets the ResourceId field's value.

func (*ConnectClientAddIn) SetURL added in v1.42.32 

func (s *ConnectClientAddIn) SetURL(v string) *ConnectClientAddIn

SetURL sets the URL field's value.

func (ConnectClientAddIn) String added in v1.42.32 

func (s ConnectClientAddIn) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionAlias added in v1.34.22 

type ConnectionAlias struct {

	// The identifier of the connection alias.
	AliasId *string `min:"13" type:"string"`

	// The association status of the connection alias.
	Associations []*ConnectionAliasAssociation `min:"1" type:"list"`

	// 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 `min:"1" type:"string"`

	// The identifier of the Amazon Web Services account that owns the connection
	// alias.
	OwnerAccountId *string `type:"string"`

	// The current state of the connection alias.
	State *string `type:"string" enum:"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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

func (ConnectionAlias) GoString added in v1.34.22 

func (s ConnectionAlias) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionAlias) SetAliasId added in v1.34.22 

func (s *ConnectionAlias) SetAliasId(v string) *ConnectionAlias

SetAliasId sets the AliasId field's value.

func (*ConnectionAlias) SetAssociations added in v1.34.22 

func (s *ConnectionAlias) SetAssociations(v []*ConnectionAliasAssociation) *ConnectionAlias

SetAssociations sets the Associations field's value.

func (*ConnectionAlias) SetConnectionString added in v1.34.22 

func (s *ConnectionAlias) SetConnectionString(v string) *ConnectionAlias

SetConnectionString sets the ConnectionString field's value.

func (*ConnectionAlias) SetOwnerAccountId added in v1.34.22 

func (s *ConnectionAlias) SetOwnerAccountId(v string) *ConnectionAlias

SetOwnerAccountId sets the OwnerAccountId field's value.

func (*ConnectionAlias) SetState added in v1.34.22 

func (s *ConnectionAlias) SetState(v string) *ConnectionAlias

SetState sets the State field's value.

func (ConnectionAlias) String added in v1.34.22 

func (s ConnectionAlias) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionAliasAssociation added in v1.34.22 

type ConnectionAliasAssociation struct {

	// The identifier of the Amazon Web Services account that associated the connection
	// alias with a directory.
	AssociatedAccountId *string `type:"string"`

	// The association status of the connection alias.
	AssociationStatus *string `type:"string" enum:"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 `min:"1" type:"string"`

	// The identifier of the directory associated with a connection alias.
	ResourceId *string `min:"1" type:"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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

func (ConnectionAliasAssociation) GoString added in v1.34.22 

func (s ConnectionAliasAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionAliasAssociation) SetAssociatedAccountId added in v1.34.22 

func (s *ConnectionAliasAssociation) SetAssociatedAccountId(v string) *ConnectionAliasAssociation

SetAssociatedAccountId sets the AssociatedAccountId field's value.

func (*ConnectionAliasAssociation) SetAssociationStatus added in v1.34.22 

func (s *ConnectionAliasAssociation) SetAssociationStatus(v string) *ConnectionAliasAssociation

SetAssociationStatus sets the AssociationStatus field's value.

func (*ConnectionAliasAssociation) SetConnectionIdentifier added in v1.34.22 

func (s *ConnectionAliasAssociation) SetConnectionIdentifier(v string) *ConnectionAliasAssociation

SetConnectionIdentifier sets the ConnectionIdentifier field's value.

func (*ConnectionAliasAssociation) SetResourceId added in v1.34.22 

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

SetResourceId sets the ResourceId field's value.

func (ConnectionAliasAssociation) String added in v1.34.22 

func (s ConnectionAliasAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConnectionAliasPermission added in v1.34.22 

type ConnectionAliasPermission struct {

	// Indicates whether the specified Amazon Web Services account is allowed to
	// associate the connection alias with a directory.
	//
	// AllowAssociation is a required field
	AllowAssociation *bool `type:"boolean" required:"true"`

	// The identifier of the Amazon Web Services account that the connection alias
	// is shared with.
	//
	// SharedAccountId is a required field
	SharedAccountId *string `type:"string" required:"true"`
	// 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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

func (ConnectionAliasPermission) GoString added in v1.34.22 

func (s ConnectionAliasPermission) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionAliasPermission) SetAllowAssociation added in v1.34.22 

func (s *ConnectionAliasPermission) SetAllowAssociation(v bool) *ConnectionAliasPermission

SetAllowAssociation sets the AllowAssociation field's value.

func (*ConnectionAliasPermission) SetSharedAccountId added in v1.34.22 

func (s *ConnectionAliasPermission) SetSharedAccountId(v string) *ConnectionAliasPermission

SetSharedAccountId sets the SharedAccountId field's value.

func (ConnectionAliasPermission) String added in v1.34.22 

func (s ConnectionAliasPermission) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConnectionAliasPermission) Validate added in v1.34.22 

func (s *ConnectionAliasPermission) Validate() error

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

type CopyWorkspaceImageInput added in v1.20.11 

type CopyWorkspaceImageInput struct {

	// A description of the image.
	Description *string `min:"1" type:"string"`

	// The name of the image.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The identifier of the source image.
	//
	// SourceImageId is a required field
	SourceImageId *string `type:"string" required:"true"`

	// The identifier of the source Region.
	//
	// SourceRegion is a required field
	SourceRegion *string `min:"1" type:"string" required:"true"`

	// The tags for the image.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CopyWorkspaceImageInput) GoString added in v1.20.11 

func (s CopyWorkspaceImageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyWorkspaceImageInput) SetDescription added in v1.20.11 

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

SetDescription sets the Description field's value.

func (*CopyWorkspaceImageInput) SetName added in v1.20.11 

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

SetName sets the Name field's value.

func (*CopyWorkspaceImageInput) SetSourceImageId added in v1.20.11 

func (s *CopyWorkspaceImageInput) SetSourceImageId(v string) *CopyWorkspaceImageInput

SetSourceImageId sets the SourceImageId field's value.

func (*CopyWorkspaceImageInput) SetSourceRegion added in v1.20.11 

func (s *CopyWorkspaceImageInput) SetSourceRegion(v string) *CopyWorkspaceImageInput

SetSourceRegion sets the SourceRegion field's value.

func (*CopyWorkspaceImageInput) SetTags added in v1.20.11 

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

SetTags sets the Tags field's value.

func (CopyWorkspaceImageInput) String added in v1.20.11 

func (s CopyWorkspaceImageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyWorkspaceImageInput) Validate added in v1.20.11 

func (s *CopyWorkspaceImageInput) Validate() error

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

type CopyWorkspaceImageOutput added in v1.20.11 

type CopyWorkspaceImageOutput struct {

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

func (CopyWorkspaceImageOutput) GoString added in v1.20.11 

func (s CopyWorkspaceImageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyWorkspaceImageOutput) SetImageId added in v1.20.11 

func (s *CopyWorkspaceImageOutput) SetImageId(v string) *CopyWorkspaceImageOutput

SetImageId sets the ImageId field's value.

func (CopyWorkspaceImageOutput) String added in v1.20.11 

func (s CopyWorkspaceImageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateConnectClientAddInInput added in v1.42.32 

type CreateConnectClientAddInInput struct {

	// The name of the client add-in.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The directory identifier for which to configure the client add-in.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`

	// The endpoint URL of the Amazon Connect client add-in.
	//
	// URL is a required field
	URL *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateConnectClientAddInInput) GoString added in v1.42.32 

func (s CreateConnectClientAddInInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectClientAddInInput) SetName added in v1.42.32 

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

SetName sets the Name field's value.

func (*CreateConnectClientAddInInput) SetResourceId added in v1.42.32 

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

SetResourceId sets the ResourceId field's value.

func (*CreateConnectClientAddInInput) SetURL added in v1.42.32 

func (s *CreateConnectClientAddInInput) SetURL(v string) *CreateConnectClientAddInInput

SetURL sets the URL field's value.

func (CreateConnectClientAddInInput) String added in v1.42.32 

func (s CreateConnectClientAddInInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectClientAddInInput) Validate added in v1.42.32 

func (s *CreateConnectClientAddInInput) Validate() error

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

type CreateConnectClientAddInOutput added in v1.42.32 

type CreateConnectClientAddInOutput struct {

	// The client add-in identifier.
	AddInId *string `min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (CreateConnectClientAddInOutput) GoString added in v1.42.32 

func (s CreateConnectClientAddInOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectClientAddInOutput) SetAddInId added in v1.42.32 

func (s *CreateConnectClientAddInOutput) SetAddInId(v string) *CreateConnectClientAddInOutput

SetAddInId sets the AddInId field's value.

func (CreateConnectClientAddInOutput) String added in v1.42.32 

func (s CreateConnectClientAddInOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateConnectionAliasInput added in v1.34.22 

type CreateConnectionAliasInput struct {

	// A connection string in the form of a fully qualified domain name (FQDN),
	// such as www.example.com.
	//
	// After you create a connection string, it is always associated to your Amazon
	// Web Services account. You cannot recreate the same connection string with
	// a different account, even if you delete all instances of it from the original
	// account. The connection string is globally reserved for your account.
	//
	// ConnectionString is a required field
	ConnectionString *string `min:"1" type:"string" required:"true"`

	// The tags to associate with the connection alias.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateConnectionAliasInput) GoString added in v1.34.22 

func (s CreateConnectionAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionAliasInput) SetConnectionString added in v1.34.22 

func (s *CreateConnectionAliasInput) SetConnectionString(v string) *CreateConnectionAliasInput

SetConnectionString sets the ConnectionString field's value.

func (*CreateConnectionAliasInput) SetTags added in v1.34.22 

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

SetTags sets the Tags field's value.

func (CreateConnectionAliasInput) String added in v1.34.22 

func (s CreateConnectionAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionAliasInput) Validate added in v1.34.22 

func (s *CreateConnectionAliasInput) Validate() error

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

type CreateConnectionAliasOutput added in v1.34.22 

type CreateConnectionAliasOutput struct {

	// The identifier of the connection alias.
	AliasId *string `min:"13" type:"string"`
	// contains filtered or unexported fields
}

func (CreateConnectionAliasOutput) GoString added in v1.34.22 

func (s CreateConnectionAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateConnectionAliasOutput) SetAliasId added in v1.34.22 

func (s *CreateConnectionAliasOutput) SetAliasId(v string) *CreateConnectionAliasOutput

SetAliasId sets the AliasId field's value.

func (CreateConnectionAliasOutput) String added in v1.34.22 

func (s CreateConnectionAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateIpGroupInput added in v1.13.39 

type CreateIpGroupInput struct {

	// The description of the group.
	GroupDesc *string `type:"string"`

	// The name of the group.
	//
	// GroupName is a required field
	GroupName *string `type:"string" required:"true"`

	// The tags. Each WorkSpaces resource can have a maximum of 50 tags.
	Tags []*Tag `type:"list"`

	// The rules to add to the group.
	UserRules []*IpRuleItem `type:"list"`
	// contains filtered or unexported fields
}

func (CreateIpGroupInput) GoString added in v1.13.39 

func (s CreateIpGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIpGroupInput) SetGroupDesc added in v1.13.39 

func (s *CreateIpGroupInput) SetGroupDesc(v string) *CreateIpGroupInput

SetGroupDesc sets the GroupDesc field's value.

func (*CreateIpGroupInput) SetGroupName added in v1.13.39 

func (s *CreateIpGroupInput) SetGroupName(v string) *CreateIpGroupInput

SetGroupName sets the GroupName field's value.

func (*CreateIpGroupInput) SetTags added in v1.19.5 

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

SetTags sets the Tags field's value.

func (*CreateIpGroupInput) SetUserRules added in v1.13.39 

func (s *CreateIpGroupInput) SetUserRules(v []*IpRuleItem) *CreateIpGroupInput

SetUserRules sets the UserRules field's value.

func (CreateIpGroupInput) String added in v1.13.39 

func (s CreateIpGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIpGroupInput) Validate added in v1.13.39 

func (s *CreateIpGroupInput) Validate() error

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

type CreateIpGroupOutput added in v1.13.39 

type CreateIpGroupOutput struct {

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

func (CreateIpGroupOutput) GoString added in v1.13.39 

func (s CreateIpGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateIpGroupOutput) SetGroupId added in v1.13.39 

func (s *CreateIpGroupOutput) SetGroupId(v string) *CreateIpGroupOutput

SetGroupId sets the GroupId field's value.

func (CreateIpGroupOutput) String added in v1.13.39 

func (s CreateIpGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateStandbyWorkspacesInput added in v1.44.140 

type CreateStandbyWorkspacesInput struct {

	// The Region of the primary WorkSpace.
	//
	// PrimaryRegion is a required field
	PrimaryRegion *string `min:"1" type:"string" required:"true"`

	// Information about the standby WorkSpace to be created.
	//
	// StandbyWorkspaces is a required field
	StandbyWorkspaces []*StandbyWorkspace `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateStandbyWorkspacesInput) GoString added in v1.44.140 

func (s CreateStandbyWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStandbyWorkspacesInput) SetPrimaryRegion added in v1.44.140 

func (s *CreateStandbyWorkspacesInput) SetPrimaryRegion(v string) *CreateStandbyWorkspacesInput

SetPrimaryRegion sets the PrimaryRegion field's value.

func (*CreateStandbyWorkspacesInput) SetStandbyWorkspaces added in v1.44.140 

func (s *CreateStandbyWorkspacesInput) SetStandbyWorkspaces(v []*StandbyWorkspace) *CreateStandbyWorkspacesInput

SetStandbyWorkspaces sets the StandbyWorkspaces field's value.

func (CreateStandbyWorkspacesInput) String added in v1.44.140 

func (s CreateStandbyWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStandbyWorkspacesInput) Validate added in v1.44.140 

func (s *CreateStandbyWorkspacesInput) Validate() error

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

type CreateStandbyWorkspacesOutput added in v1.44.140 

type CreateStandbyWorkspacesOutput struct {

	// Information about the standby WorkSpace that could not be created.
	FailedStandbyRequests []*FailedCreateStandbyWorkspacesRequest `type:"list"`

	// Information about the standby WorkSpace that was created.
	PendingStandbyRequests []*PendingCreateStandbyWorkspacesRequest `type:"list"`
	// contains filtered or unexported fields
}

func (CreateStandbyWorkspacesOutput) GoString added in v1.44.140 

func (s CreateStandbyWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateStandbyWorkspacesOutput) SetFailedStandbyRequests added in v1.44.140 

func (s *CreateStandbyWorkspacesOutput) SetFailedStandbyRequests(v []*FailedCreateStandbyWorkspacesRequest) *CreateStandbyWorkspacesOutput

SetFailedStandbyRequests sets the FailedStandbyRequests field's value.

func (*CreateStandbyWorkspacesOutput) SetPendingStandbyRequests added in v1.44.140 

func (s *CreateStandbyWorkspacesOutput) SetPendingStandbyRequests(v []*PendingCreateStandbyWorkspacesRequest) *CreateStandbyWorkspacesOutput

SetPendingStandbyRequests sets the PendingStandbyRequests field's value.

func (CreateStandbyWorkspacesOutput) String added in v1.44.140 

func (s CreateStandbyWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTagsInput added in v1.1.27 

type CreateTagsInput struct {

	// The identifier of the WorkSpaces resource. The supported resource types are
	// WorkSpaces, registered directories, images, custom bundles, IP access control
	// groups, and connection aliases.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

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

func (CreateTagsInput) GoString added in v1.1.27 

func (s CreateTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTagsInput) SetResourceId added in v1.5.0 

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

SetResourceId sets the ResourceId field's value.

func (*CreateTagsInput) SetTags added in v1.5.0 

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

SetTags sets the Tags field's value.

func (CreateTagsInput) String added in v1.1.27 

func (s CreateTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTagsInput) Validate added in v1.1.27 

func (s *CreateTagsInput) Validate() error

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

type CreateTagsOutput added in v1.1.27 

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

func (CreateTagsOutput) GoString added in v1.1.27 

func (s CreateTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CreateTagsOutput) String added in v1.1.27 

func (s CreateTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateUpdatedWorkspaceImageInput added in v1.40.53 

type CreateUpdatedWorkspaceImageInput struct {

	// A description of whether updates for the WorkSpace image are available.
	//
	// Description is a required field
	Description *string `min:"1" type:"string" required:"true"`

	// The name of the new updated WorkSpace image.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The identifier of the source WorkSpace image.
	//
	// SourceImageId is a required field
	SourceImageId *string `type:"string" required:"true"`

	// The tags that you want to add to the new updated WorkSpace image.
	//
	// To add tags at the same time when you're creating the updated image, you
	// must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateUpdatedWorkspaceImageInput) GoString added in v1.40.53 

func (s CreateUpdatedWorkspaceImageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUpdatedWorkspaceImageInput) SetDescription added in v1.40.53 

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

SetDescription sets the Description field's value.

func (*CreateUpdatedWorkspaceImageInput) SetName added in v1.40.53 

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

SetName sets the Name field's value.

func (*CreateUpdatedWorkspaceImageInput) SetSourceImageId added in v1.40.53 

func (s *CreateUpdatedWorkspaceImageInput) SetSourceImageId(v string) *CreateUpdatedWorkspaceImageInput

SetSourceImageId sets the SourceImageId field's value.

func (*CreateUpdatedWorkspaceImageInput) SetTags added in v1.40.53 

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

SetTags sets the Tags field's value.

func (CreateUpdatedWorkspaceImageInput) String added in v1.40.53 

func (s CreateUpdatedWorkspaceImageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUpdatedWorkspaceImageInput) Validate added in v1.40.53 

func (s *CreateUpdatedWorkspaceImageInput) Validate() error

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

type CreateUpdatedWorkspaceImageOutput added in v1.40.53 

type CreateUpdatedWorkspaceImageOutput struct {

	// The identifier of the new updated WorkSpace image.
	ImageId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateUpdatedWorkspaceImageOutput) GoString added in v1.40.53 

func (s CreateUpdatedWorkspaceImageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateUpdatedWorkspaceImageOutput) SetImageId added in v1.40.53 

func (s *CreateUpdatedWorkspaceImageOutput) SetImageId(v string) *CreateUpdatedWorkspaceImageOutput

SetImageId sets the ImageId field's value.

func (CreateUpdatedWorkspaceImageOutput) String added in v1.40.53 

func (s CreateUpdatedWorkspaceImageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkspaceBundleInput added in v1.37.30 

type CreateWorkspaceBundleInput struct {

	// The description of the bundle.
	//
	// BundleDescription is a required field
	BundleDescription *string `min:"1" type:"string" required:"true"`

	// The name of the bundle.
	//
	// BundleName is a required field
	BundleName *string `min:"1" type:"string" required:"true"`

	// Describes the compute type of the bundle.
	//
	// ComputeType is a required field
	ComputeType *ComputeType `type:"structure" required:"true"`

	// The identifier of the image that is used to create the bundle.
	//
	// ImageId is a required field
	ImageId *string `type:"string" required:"true"`

	// Describes the root volume for a WorkSpace bundle.
	RootStorage *RootStorage `type:"structure"`

	// The tags associated with the bundle.
	//
	// To add tags at the same time when you're creating the bundle, you must create
	// an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.
	Tags []*Tag `type:"list"`

	// Describes the user volume for a WorkSpace bundle.
	//
	// UserStorage is a required field
	UserStorage *UserStorage `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWorkspaceBundleInput) GoString added in v1.37.30 

func (s CreateWorkspaceBundleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceBundleInput) SetBundleDescription added in v1.37.30 

func (s *CreateWorkspaceBundleInput) SetBundleDescription(v string) *CreateWorkspaceBundleInput

SetBundleDescription sets the BundleDescription field's value.

func (*CreateWorkspaceBundleInput) SetBundleName added in v1.37.30 

func (s *CreateWorkspaceBundleInput) SetBundleName(v string) *CreateWorkspaceBundleInput

SetBundleName sets the BundleName field's value.

func (*CreateWorkspaceBundleInput) SetComputeType added in v1.37.30 

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

SetComputeType sets the ComputeType field's value.

func (*CreateWorkspaceBundleInput) SetImageId added in v1.37.30 

func (s *CreateWorkspaceBundleInput) SetImageId(v string) *CreateWorkspaceBundleInput

SetImageId sets the ImageId field's value.

func (*CreateWorkspaceBundleInput) SetRootStorage added in v1.37.30 

func (s *CreateWorkspaceBundleInput) SetRootStorage(v *RootStorage) *CreateWorkspaceBundleInput

SetRootStorage sets the RootStorage field's value.

func (*CreateWorkspaceBundleInput) SetTags added in v1.37.30 

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

SetTags sets the Tags field's value.

func (*CreateWorkspaceBundleInput) SetUserStorage added in v1.37.30 

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

SetUserStorage sets the UserStorage field's value.

func (CreateWorkspaceBundleInput) String added in v1.37.30 

func (s CreateWorkspaceBundleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceBundleInput) Validate added in v1.37.30 

func (s *CreateWorkspaceBundleInput) Validate() error

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

type CreateWorkspaceBundleOutput added in v1.37.30 

type CreateWorkspaceBundleOutput struct {

	// Describes a WorkSpace bundle.
	WorkspaceBundle *WorkspaceBundle `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateWorkspaceBundleOutput) GoString added in v1.37.30 

func (s CreateWorkspaceBundleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceBundleOutput) SetWorkspaceBundle added in v1.37.30 

func (s *CreateWorkspaceBundleOutput) SetWorkspaceBundle(v *WorkspaceBundle) *CreateWorkspaceBundleOutput

SetWorkspaceBundle sets the WorkspaceBundle field's value.

func (CreateWorkspaceBundleOutput) String added in v1.37.30 

func (s CreateWorkspaceBundleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkspaceImageInput added in v1.44.64 

type CreateWorkspaceImageInput struct {

	// The description of the new WorkSpace image.
	//
	// Description is a required field
	Description *string `min:"1" type:"string" required:"true"`

	// The name of the new WorkSpace image.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The tags that you want to add to the new WorkSpace image. To add tags when
	// you're creating the image, you must create an IAM policy that grants your
	// IAM user permission to use workspaces:CreateTags.
	Tags []*Tag `type:"list"`

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

func (CreateWorkspaceImageInput) GoString added in v1.44.64 

func (s CreateWorkspaceImageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceImageInput) SetDescription added in v1.44.64 

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

SetDescription sets the Description field's value.

func (*CreateWorkspaceImageInput) SetName added in v1.44.64 

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

SetName sets the Name field's value.

func (*CreateWorkspaceImageInput) SetTags added in v1.44.64 

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

SetTags sets the Tags field's value.

func (*CreateWorkspaceImageInput) SetWorkspaceId added in v1.44.64 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateWorkspaceImageInput) String added in v1.44.64 

func (s CreateWorkspaceImageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceImageInput) Validate added in v1.44.64 

func (s *CreateWorkspaceImageInput) Validate() error

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

type CreateWorkspaceImageOutput added in v1.44.64 

type CreateWorkspaceImageOutput struct {

	// The date when the image was created.
	Created *time.Time `type:"timestamp"`

	// The description of the image.
	Description *string `min:"1" type:"string"`

	// The identifier of the new WorkSpace image.
	ImageId *string `type:"string"`

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

	// The operating system that the image is running.
	OperatingSystem *OperatingSystem `type:"structure"`

	// The identifier of the Amazon Web Services account that owns the image.
	OwnerAccountId *string `type:"string"`

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

	// The availability status of the image.
	State *string `type:"string" enum:"WorkspaceImageState"`
	// contains filtered or unexported fields
}

func (CreateWorkspaceImageOutput) GoString added in v1.44.64 

func (s CreateWorkspaceImageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceImageOutput) SetCreated added in v1.44.64 

func (s *CreateWorkspaceImageOutput) SetCreated(v time.Time) *CreateWorkspaceImageOutput

SetCreated sets the Created field's value.

func (*CreateWorkspaceImageOutput) SetDescription added in v1.44.64 

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

SetDescription sets the Description field's value.

func (*CreateWorkspaceImageOutput) SetImageId added in v1.44.64 

func (s *CreateWorkspaceImageOutput) SetImageId(v string) *CreateWorkspaceImageOutput

SetImageId sets the ImageId field's value.

func (*CreateWorkspaceImageOutput) SetName added in v1.44.64 

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

SetName sets the Name field's value.

func (*CreateWorkspaceImageOutput) SetOperatingSystem added in v1.44.64 

func (s *CreateWorkspaceImageOutput) SetOperatingSystem(v *OperatingSystem) *CreateWorkspaceImageOutput

SetOperatingSystem sets the OperatingSystem field's value.

func (*CreateWorkspaceImageOutput) SetOwnerAccountId added in v1.44.64 

func (s *CreateWorkspaceImageOutput) SetOwnerAccountId(v string) *CreateWorkspaceImageOutput

SetOwnerAccountId sets the OwnerAccountId field's value.

func (*CreateWorkspaceImageOutput) SetRequiredTenancy added in v1.44.64 

func (s *CreateWorkspaceImageOutput) SetRequiredTenancy(v string) *CreateWorkspaceImageOutput

SetRequiredTenancy sets the RequiredTenancy field's value.

func (*CreateWorkspaceImageOutput) SetState added in v1.44.64 

func (s *CreateWorkspaceImageOutput) SetState(v string) *CreateWorkspaceImageOutput

SetState sets the State field's value.

func (CreateWorkspaceImageOutput) String added in v1.44.64 

func (s CreateWorkspaceImageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkspacesInput 

type CreateWorkspacesInput struct {

	// The WorkSpaces to create. You can specify up to 25 WorkSpaces.
	//
	// Workspaces is a required field
	Workspaces []*WorkspaceRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWorkspacesInput) GoString added in v0.6.5 

func (s CreateWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspacesInput) SetWorkspaces added in v1.5.0 

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

SetWorkspaces sets the Workspaces field's value.

func (CreateWorkspacesInput) String added in v0.6.5 

func (s CreateWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspacesInput) Validate added in v1.1.21 

func (s *CreateWorkspacesInput) Validate() error

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

type CreateWorkspacesOutput 

type CreateWorkspacesOutput struct {

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

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

func (CreateWorkspacesOutput) GoString added in v0.6.5 

func (s CreateWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspacesOutput) SetFailedRequests added in v1.5.0 

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

SetFailedRequests sets the FailedRequests field's value.

func (*CreateWorkspacesOutput) SetPendingRequests added in v1.5.0 

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

SetPendingRequests sets the PendingRequests field's value.

func (CreateWorkspacesOutput) String added in v0.6.5 

func (s CreateWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataReplicationSettings added in v1.48.4 

type DataReplicationSettings struct {

	// Indicates whether data replication is enabled, and if enabled, the type of
	// data replication.
	DataReplication *string `type:"string" enum:"DataReplication"`

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

Describes the data replication settings.

func (DataReplicationSettings) GoString added in v1.48.4 

func (s DataReplicationSettings) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataReplicationSettings) SetDataReplication added in v1.48.4 

func (s *DataReplicationSettings) SetDataReplication(v string) *DataReplicationSettings

SetDataReplication sets the DataReplication field's value.

func (*DataReplicationSettings) SetRecoverySnapshotTime added in v1.48.4 

func (s *DataReplicationSettings) SetRecoverySnapshotTime(v time.Time) *DataReplicationSettings

SetRecoverySnapshotTime sets the RecoverySnapshotTime field's value.

func (DataReplicationSettings) String added in v1.48.4 

func (s DataReplicationSettings) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DefaultClientBrandingAttributes added in v1.43.30 

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 `min:"1" type:"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 `type:"map"`

	// The logo. The only image format accepted is a binary data object that is
	// converted from a .png file.
	LogoUrl *string `min:"1" type:"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 `min:"6" type:"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 `min:"1" type:"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.

func (DefaultClientBrandingAttributes) GoString added in v1.43.30 

func (s DefaultClientBrandingAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive". 

func (s *DefaultClientBrandingAttributes) SetForgotPasswordLink(v string) *DefaultClientBrandingAttributes

SetForgotPasswordLink sets the ForgotPasswordLink field's value.

func (*DefaultClientBrandingAttributes) SetLoginMessage added in v1.43.30 

func (s *DefaultClientBrandingAttributes) SetLoginMessage(v map[string]*string) *DefaultClientBrandingAttributes

SetLoginMessage sets the LoginMessage field's value.

func (*DefaultClientBrandingAttributes) SetLogoUrl added in v1.43.30 

func (s *DefaultClientBrandingAttributes) SetLogoUrl(v string) *DefaultClientBrandingAttributes

SetLogoUrl sets the LogoUrl field's value.

func (*DefaultClientBrandingAttributes) SetSupportEmail added in v1.43.30 

func (s *DefaultClientBrandingAttributes) SetSupportEmail(v string) *DefaultClientBrandingAttributes

SetSupportEmail sets the SupportEmail field's value. 

func (s *DefaultClientBrandingAttributes) SetSupportLink(v string) *DefaultClientBrandingAttributes

SetSupportLink sets the SupportLink field's value.

func (DefaultClientBrandingAttributes) String added in v1.43.30 

func (s DefaultClientBrandingAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DefaultImportClientBrandingAttributes added in v1.43.30 

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 `min:"1" type:"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 `type:"map"`

	// converted from a .png file.
	// Logo is automatically base64 encoded/decoded by the SDK.
	Logo []byte `min:"1" type:"blob"`

	// 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 `min:"6" type:"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 `min:"1" type:"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.

func (DefaultImportClientBrandingAttributes) GoString added in v1.43.30 

func (s DefaultImportClientBrandingAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive". 

func (s *DefaultImportClientBrandingAttributes) SetForgotPasswordLink(v string) *DefaultImportClientBrandingAttributes

SetForgotPasswordLink sets the ForgotPasswordLink field's value.

func (*DefaultImportClientBrandingAttributes) SetLoginMessage added in v1.43.30 

func (s *DefaultImportClientBrandingAttributes) SetLoginMessage(v map[string]*string) *DefaultImportClientBrandingAttributes

SetLoginMessage sets the LoginMessage field's value. 

func (s *DefaultImportClientBrandingAttributes) SetLogo(v []byte) *DefaultImportClientBrandingAttributes

SetLogo sets the Logo field's value.

func (*DefaultImportClientBrandingAttributes) SetSupportEmail added in v1.43.30 

func (s *DefaultImportClientBrandingAttributes) SetSupportEmail(v string) *DefaultImportClientBrandingAttributes

SetSupportEmail sets the SupportEmail field's value. 

func (s *DefaultImportClientBrandingAttributes) SetSupportLink(v string) *DefaultImportClientBrandingAttributes

SetSupportLink sets the SupportLink field's value.

func (DefaultImportClientBrandingAttributes) String added in v1.43.30 

func (s DefaultImportClientBrandingAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultImportClientBrandingAttributes) Validate added in v1.43.30 

func (s *DefaultImportClientBrandingAttributes) Validate() error

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

type DefaultWorkspaceCreationProperties 

type DefaultWorkspaceCreationProperties struct {

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

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

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

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

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

	// Specifies whether WorkSpace users are local administrators on their WorkSpaces.
	UserEnabledAsLocalAdministrator *bool `type:"boolean"`
	// 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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html).

func (DefaultWorkspaceCreationProperties) GoString added in v0.6.5 

func (s DefaultWorkspaceCreationProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId added in v1.5.0 

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

SetCustomSecurityGroupId sets the CustomSecurityGroupId field's value.

func (*DefaultWorkspaceCreationProperties) SetDefaultOu added in v1.5.0 

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

SetDefaultOu sets the DefaultOu field's value.

func (*DefaultWorkspaceCreationProperties) SetEnableInternetAccess added in v1.5.0 

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

SetEnableInternetAccess sets the EnableInternetAccess field's value.

func (*DefaultWorkspaceCreationProperties) SetEnableMaintenanceMode added in v1.25.36 

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

SetEnableMaintenanceMode sets the EnableMaintenanceMode field's value.

func (*DefaultWorkspaceCreationProperties) SetEnableWorkDocs added in v1.5.0 

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

SetEnableWorkDocs sets the EnableWorkDocs field's value.

func (*DefaultWorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator added in v1.5.0 

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

SetUserEnabledAsLocalAdministrator sets the UserEnabledAsLocalAdministrator field's value.

func (DefaultWorkspaceCreationProperties) String added in v0.6.5 

func (s DefaultWorkspaceCreationProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteClientBrandingInput added in v1.43.30 

type DeleteClientBrandingInput struct {

	// The device type for which you want to delete client branding.
	//
	// Platforms is a required field
	Platforms []*string `min:"1" type:"list" required:"true" enum:"ClientDeviceType"`

	// The directory identifier of the WorkSpace for which you want to delete client
	// branding.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteClientBrandingInput) GoString added in v1.43.30 

func (s DeleteClientBrandingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteClientBrandingInput) SetPlatforms added in v1.43.30 

func (s *DeleteClientBrandingInput) SetPlatforms(v []*string) *DeleteClientBrandingInput

SetPlatforms sets the Platforms field's value.

func (*DeleteClientBrandingInput) SetResourceId added in v1.43.30 

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

SetResourceId sets the ResourceId field's value.

func (DeleteClientBrandingInput) String added in v1.43.30 

func (s DeleteClientBrandingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteClientBrandingInput) Validate added in v1.43.30 

func (s *DeleteClientBrandingInput) Validate() error

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

type DeleteClientBrandingOutput added in v1.43.30 

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

func (DeleteClientBrandingOutput) GoString added in v1.43.30 

func (s DeleteClientBrandingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteClientBrandingOutput) String added in v1.43.30 

func (s DeleteClientBrandingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteConnectClientAddInInput added in v1.42.32 

type DeleteConnectClientAddInInput struct {

	// The identifier of the client add-in to delete.
	//
	// AddInId is a required field
	AddInId *string `min:"36" type:"string" required:"true"`

	// The directory identifier for which the client add-in is configured.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteConnectClientAddInInput) GoString added in v1.42.32 

func (s DeleteConnectClientAddInInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConnectClientAddInInput) SetAddInId added in v1.42.32 

func (s *DeleteConnectClientAddInInput) SetAddInId(v string) *DeleteConnectClientAddInInput

SetAddInId sets the AddInId field's value.

func (*DeleteConnectClientAddInInput) SetResourceId added in v1.42.32 

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

SetResourceId sets the ResourceId field's value.

func (DeleteConnectClientAddInInput) String added in v1.42.32 

func (s DeleteConnectClientAddInInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConnectClientAddInInput) Validate added in v1.42.32 

func (s *DeleteConnectClientAddInInput) Validate() error

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

type DeleteConnectClientAddInOutput added in v1.42.32 

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

func (DeleteConnectClientAddInOutput) GoString added in v1.42.32 

func (s DeleteConnectClientAddInOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteConnectClientAddInOutput) String added in v1.42.32 

func (s DeleteConnectClientAddInOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteConnectionAliasInput added in v1.34.22 

type DeleteConnectionAliasInput struct {

	// The identifier of the connection alias to delete.
	//
	// AliasId is a required field
	AliasId *string `min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteConnectionAliasInput) GoString added in v1.34.22 

func (s DeleteConnectionAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConnectionAliasInput) SetAliasId added in v1.34.22 

func (s *DeleteConnectionAliasInput) SetAliasId(v string) *DeleteConnectionAliasInput

SetAliasId sets the AliasId field's value.

func (DeleteConnectionAliasInput) String added in v1.34.22 

func (s DeleteConnectionAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteConnectionAliasInput) Validate added in v1.34.22 

func (s *DeleteConnectionAliasInput) Validate() error

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

type DeleteConnectionAliasOutput added in v1.34.22 

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

func (DeleteConnectionAliasOutput) GoString added in v1.34.22 

func (s DeleteConnectionAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteConnectionAliasOutput) String added in v1.34.22 

func (s DeleteConnectionAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteIpGroupInput added in v1.13.39 

type DeleteIpGroupInput struct {

	// The identifier of the IP access control group.
	//
	// GroupId is a required field
	GroupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteIpGroupInput) GoString added in v1.13.39 

func (s DeleteIpGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIpGroupInput) SetGroupId added in v1.13.39 

func (s *DeleteIpGroupInput) SetGroupId(v string) *DeleteIpGroupInput

SetGroupId sets the GroupId field's value.

func (DeleteIpGroupInput) String added in v1.13.39 

func (s DeleteIpGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteIpGroupInput) Validate added in v1.13.39 

func (s *DeleteIpGroupInput) Validate() error

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

type DeleteIpGroupOutput added in v1.13.39 

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

func (DeleteIpGroupOutput) GoString added in v1.13.39 

func (s DeleteIpGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteIpGroupOutput) String added in v1.13.39 

func (s DeleteIpGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTagsInput added in v1.1.27 

type DeleteTagsInput struct {

	// The identifier of the WorkSpaces resource. The supported resource types are
	// WorkSpaces, registered directories, images, custom bundles, IP access control
	// groups, and connection aliases.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

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

func (DeleteTagsInput) GoString added in v1.1.27 

func (s DeleteTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTagsInput) SetResourceId added in v1.5.0 

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

SetResourceId sets the ResourceId field's value.

func (*DeleteTagsInput) SetTagKeys added in v1.5.0 

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

SetTagKeys sets the TagKeys field's value.

func (DeleteTagsInput) String added in v1.1.27 

func (s DeleteTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTagsInput) Validate added in v1.1.27 

func (s *DeleteTagsInput) Validate() error

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

type DeleteTagsOutput added in v1.1.27 

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

func (DeleteTagsOutput) GoString added in v1.1.27 

func (s DeleteTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTagsOutput) String added in v1.1.27 

func (s DeleteTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkspaceBundleInput added in v1.37.30 

type DeleteWorkspaceBundleInput struct {

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

func (DeleteWorkspaceBundleInput) GoString added in v1.37.30 

func (s DeleteWorkspaceBundleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceBundleInput) SetBundleId added in v1.37.30 

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

SetBundleId sets the BundleId field's value.

func (DeleteWorkspaceBundleInput) String added in v1.37.30 

func (s DeleteWorkspaceBundleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkspaceBundleOutput added in v1.37.30 

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

func (DeleteWorkspaceBundleOutput) GoString added in v1.37.30 

func (s DeleteWorkspaceBundleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWorkspaceBundleOutput) String added in v1.37.30 

func (s DeleteWorkspaceBundleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkspaceImageInput added in v1.15.78 

type DeleteWorkspaceImageInput struct {

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

func (DeleteWorkspaceImageInput) GoString added in v1.15.78 

func (s DeleteWorkspaceImageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceImageInput) SetImageId added in v1.15.78 

func (s *DeleteWorkspaceImageInput) SetImageId(v string) *DeleteWorkspaceImageInput

SetImageId sets the ImageId field's value.

func (DeleteWorkspaceImageInput) String added in v1.15.78 

func (s DeleteWorkspaceImageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceImageInput) Validate added in v1.15.78 

func (s *DeleteWorkspaceImageInput) Validate() error

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

type DeleteWorkspaceImageOutput added in v1.15.78 

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

func (DeleteWorkspaceImageOutput) GoString added in v1.15.78 

func (s DeleteWorkspaceImageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWorkspaceImageOutput) String added in v1.15.78 

func (s DeleteWorkspaceImageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeployWorkspaceApplicationsInput added in v1.45.23 

type DeployWorkspaceApplicationsInput struct {

	// Indicates whether the force flag is applied for the specified WorkSpace.
	// When the force flag is enabled, it allows previously failed deployments to
	// be retried.
	Force *bool `type:"boolean"`

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

func (DeployWorkspaceApplicationsInput) GoString added in v1.45.23 

func (s DeployWorkspaceApplicationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeployWorkspaceApplicationsInput) SetForce added in v1.45.23 

func (s *DeployWorkspaceApplicationsInput) SetForce(v bool) *DeployWorkspaceApplicationsInput

SetForce sets the Force field's value.

func (*DeployWorkspaceApplicationsInput) SetWorkspaceId added in v1.45.23 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (DeployWorkspaceApplicationsInput) String added in v1.45.23 

func (s DeployWorkspaceApplicationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeployWorkspaceApplicationsInput) Validate added in v1.45.23 

func (s *DeployWorkspaceApplicationsInput) Validate() error

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

type DeployWorkspaceApplicationsOutput added in v1.45.23 

type DeployWorkspaceApplicationsOutput struct {

	// The list of deployed associations and information about them.
	Deployment *WorkSpaceApplicationDeployment `type:"structure"`
	// contains filtered or unexported fields
}

func (DeployWorkspaceApplicationsOutput) GoString added in v1.45.23 

func (s DeployWorkspaceApplicationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeployWorkspaceApplicationsOutput) SetDeployment added in v1.45.23 

func (s *DeployWorkspaceApplicationsOutput) SetDeployment(v *WorkSpaceApplicationDeployment) *DeployWorkspaceApplicationsOutput

SetDeployment sets the Deployment field's value.

func (DeployWorkspaceApplicationsOutput) String added in v1.45.23 

func (s DeployWorkspaceApplicationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeregisterWorkspaceDirectoryInput added in v1.25.36 

type DeregisterWorkspaceDirectoryInput struct {

	// The identifier of the directory. If any WorkSpaces are registered to this
	// directory, you must remove them before you deregister the directory, or you
	// will receive an OperationNotSupportedException error.
	//
	// DirectoryId is a required field
	DirectoryId *string `min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterWorkspaceDirectoryInput) GoString added in v1.25.36 

func (s DeregisterWorkspaceDirectoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterWorkspaceDirectoryInput) SetDirectoryId added in v1.25.36 

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

SetDirectoryId sets the DirectoryId field's value.

func (DeregisterWorkspaceDirectoryInput) String added in v1.25.36 

func (s DeregisterWorkspaceDirectoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeregisterWorkspaceDirectoryInput) Validate added in v1.25.36 

func (s *DeregisterWorkspaceDirectoryInput) Validate() error

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

type DeregisterWorkspaceDirectoryOutput added in v1.25.36 

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

func (DeregisterWorkspaceDirectoryOutput) GoString added in v1.25.36 

func (s DeregisterWorkspaceDirectoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeregisterWorkspaceDirectoryOutput) String added in v1.25.36 

func (s DeregisterWorkspaceDirectoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountInput added in v1.15.78 

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

func (DescribeAccountInput) GoString added in v1.15.78 

func (s DescribeAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeAccountInput) String added in v1.15.78 

func (s DescribeAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountModificationsInput added in v1.15.78 

type DescribeAccountModificationsInput struct {

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccountModificationsInput) GoString added in v1.15.78 

func (s DescribeAccountModificationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountModificationsInput) SetNextToken added in v1.15.78 

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

SetNextToken sets the NextToken field's value.

func (DescribeAccountModificationsInput) String added in v1.15.78 

func (s DescribeAccountModificationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountModificationsInput) Validate added in v1.15.78 

func (s *DescribeAccountModificationsInput) Validate() error

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

type DescribeAccountModificationsOutput added in v1.15.78 

type DescribeAccountModificationsOutput struct {

	// The list of modifications to the configuration of BYOL.
	AccountModifications []*AccountModification `type:"list"`

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeAccountModificationsOutput) GoString added in v1.15.78 

func (s DescribeAccountModificationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountModificationsOutput) SetAccountModifications added in v1.15.78 

func (s *DescribeAccountModificationsOutput) SetAccountModifications(v []*AccountModification) *DescribeAccountModificationsOutput

SetAccountModifications sets the AccountModifications field's value.

func (*DescribeAccountModificationsOutput) SetNextToken added in v1.15.78 

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

SetNextToken sets the NextToken field's value.

func (DescribeAccountModificationsOutput) String added in v1.15.78 

func (s DescribeAccountModificationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccountOutput added in v1.15.78 

type DescribeAccountOutput struct {

	// The IP address range, specified as an IPv4 CIDR block, used for the management
	// network interface.
	//
	// The management network interface is connected to a secure Amazon WorkSpaces
	// management network. It is used for interactive streaming of the WorkSpace
	// desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage
	// the WorkSpace.
	DedicatedTenancyManagementCidrRange *string `type:"string"`

	// The status of BYOL (whether BYOL is enabled or disabled).
	DedicatedTenancySupport *string `type:"string" enum:"DedicatedTenancySupportResultEnum"`
	// contains filtered or unexported fields
}

func (DescribeAccountOutput) GoString added in v1.15.78 

func (s DescribeAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccountOutput) SetDedicatedTenancyManagementCidrRange added in v1.15.78 

func (s *DescribeAccountOutput) SetDedicatedTenancyManagementCidrRange(v string) *DescribeAccountOutput

SetDedicatedTenancyManagementCidrRange sets the DedicatedTenancyManagementCidrRange field's value.

func (*DescribeAccountOutput) SetDedicatedTenancySupport added in v1.15.78 

func (s *DescribeAccountOutput) SetDedicatedTenancySupport(v string) *DescribeAccountOutput

SetDedicatedTenancySupport sets the DedicatedTenancySupport field's value.

func (DescribeAccountOutput) String added in v1.15.78 

func (s DescribeAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeApplicationAssociationsInput added in v1.45.23 

type DescribeApplicationAssociationsInput struct {

	// The identifier of the specified application.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

	// The resource type of the associated resources.
	//
	// AssociatedResourceTypes is a required field
	AssociatedResourceTypes []*string `type:"list" required:"true" enum:"ApplicationAssociatedResourceType"`

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeApplicationAssociationsInput) GoString added in v1.45.23 

func (s DescribeApplicationAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeApplicationAssociationsInput) SetApplicationId added in v1.45.23 

func (s *DescribeApplicationAssociationsInput) SetApplicationId(v string) *DescribeApplicationAssociationsInput

SetApplicationId sets the ApplicationId field's value.

func (*DescribeApplicationAssociationsInput) SetAssociatedResourceTypes added in v1.45.23 

func (s *DescribeApplicationAssociationsInput) SetAssociatedResourceTypes(v []*string) *DescribeApplicationAssociationsInput

SetAssociatedResourceTypes sets the AssociatedResourceTypes field's value.

func (*DescribeApplicationAssociationsInput) SetMaxResults added in v1.45.23 

func (s *DescribeApplicationAssociationsInput) SetMaxResults(v int64) *DescribeApplicationAssociationsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeApplicationAssociationsInput) SetNextToken added in v1.45.23 

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

SetNextToken sets the NextToken field's value.

func (DescribeApplicationAssociationsInput) String added in v1.45.23 

func (s DescribeApplicationAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeApplicationAssociationsInput) Validate added in v1.45.23 

func (s *DescribeApplicationAssociationsInput) Validate() error

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

type DescribeApplicationAssociationsOutput added in v1.45.23 

type DescribeApplicationAssociationsOutput struct {

	// List of associations and information about them.
	Associations []*ApplicationResourceAssociation `type:"list"`

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeApplicationAssociationsOutput) GoString added in v1.45.23 

func (s DescribeApplicationAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeApplicationAssociationsOutput) SetAssociations added in v1.45.23 

func (s *DescribeApplicationAssociationsOutput) SetAssociations(v []*ApplicationResourceAssociation) *DescribeApplicationAssociationsOutput

SetAssociations sets the Associations field's value.

func (*DescribeApplicationAssociationsOutput) SetNextToken added in v1.45.23 

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

SetNextToken sets the NextToken field's value.

func (DescribeApplicationAssociationsOutput) String added in v1.45.23 

func (s DescribeApplicationAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeApplicationsInput added in v1.45.23 

type DescribeApplicationsInput struct {

	// The identifiers of one or more applications.
	ApplicationIds []*string `min:"1" type:"list"`

	// The compute types supported by the applications.
	ComputeTypeNames []*string `type:"list" enum:"Compute"`

	// The license availability for the applications.
	LicenseType *string `type:"string" enum:"WorkSpaceApplicationLicenseType"`

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The operating systems supported by the applications.
	OperatingSystemNames []*string `type:"list" enum:"OperatingSystemName"`

	// The owner of the applications.
	Owner *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeApplicationsInput) GoString added in v1.45.23 

func (s DescribeApplicationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeApplicationsInput) SetApplicationIds added in v1.45.23 

func (s *DescribeApplicationsInput) SetApplicationIds(v []*string) *DescribeApplicationsInput

SetApplicationIds sets the ApplicationIds field's value.

func (*DescribeApplicationsInput) SetComputeTypeNames added in v1.45.23 

func (s *DescribeApplicationsInput) SetComputeTypeNames(v []*string) *DescribeApplicationsInput

SetComputeTypeNames sets the ComputeTypeNames field's value.

func (*DescribeApplicationsInput) SetLicenseType added in v1.45.23 

func (s *DescribeApplicationsInput) SetLicenseType(v string) *DescribeApplicationsInput

SetLicenseType sets the LicenseType field's value.

func (*DescribeApplicationsInput) SetMaxResults added in v1.45.23 

func (s *DescribeApplicationsInput) SetMaxResults(v int64) *DescribeApplicationsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeApplicationsInput) SetNextToken added in v1.45.23 

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

SetNextToken sets the NextToken field's value.

func (*DescribeApplicationsInput) SetOperatingSystemNames added in v1.45.23 

func (s *DescribeApplicationsInput) SetOperatingSystemNames(v []*string) *DescribeApplicationsInput

SetOperatingSystemNames sets the OperatingSystemNames field's value.

func (*DescribeApplicationsInput) SetOwner added in v1.45.23 

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

SetOwner sets the Owner field's value.

func (DescribeApplicationsInput) String added in v1.45.23 

func (s DescribeApplicationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeApplicationsInput) Validate added in v1.45.23 

func (s *DescribeApplicationsInput) Validate() error

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

type DescribeApplicationsOutput added in v1.45.23 

type DescribeApplicationsOutput struct {

	// List of information about the specified applications.
	Applications []*WorkSpaceApplication `type:"list"`

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeApplicationsOutput) GoString added in v1.45.23 

func (s DescribeApplicationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeApplicationsOutput) SetApplications added in v1.45.23 

func (s *DescribeApplicationsOutput) SetApplications(v []*WorkSpaceApplication) *DescribeApplicationsOutput

SetApplications sets the Applications field's value.

func (*DescribeApplicationsOutput) SetNextToken added in v1.45.23 

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

SetNextToken sets the NextToken field's value.

func (DescribeApplicationsOutput) String added in v1.45.23 

func (s DescribeApplicationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBundleAssociationsInput added in v1.45.23 

type DescribeBundleAssociationsInput struct {

	// The resource types of the associated resource.
	//
	// AssociatedResourceTypes is a required field
	AssociatedResourceTypes []*string `type:"list" required:"true" enum:"BundleAssociatedResourceType"`

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

func (DescribeBundleAssociationsInput) GoString added in v1.45.23 

func (s DescribeBundleAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBundleAssociationsInput) SetAssociatedResourceTypes added in v1.45.23 

func (s *DescribeBundleAssociationsInput) SetAssociatedResourceTypes(v []*string) *DescribeBundleAssociationsInput

SetAssociatedResourceTypes sets the AssociatedResourceTypes field's value.

func (*DescribeBundleAssociationsInput) SetBundleId added in v1.45.23 

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

SetBundleId sets the BundleId field's value.

func (DescribeBundleAssociationsInput) String added in v1.45.23 

func (s DescribeBundleAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBundleAssociationsInput) Validate added in v1.45.23 

func (s *DescribeBundleAssociationsInput) Validate() error

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

type DescribeBundleAssociationsOutput added in v1.45.23 

type DescribeBundleAssociationsOutput struct {

	// List of information about the specified associations.
	Associations []*BundleResourceAssociation `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeBundleAssociationsOutput) GoString added in v1.45.23 

func (s DescribeBundleAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBundleAssociationsOutput) SetAssociations added in v1.45.23 

func (s *DescribeBundleAssociationsOutput) SetAssociations(v []*BundleResourceAssociation) *DescribeBundleAssociationsOutput

SetAssociations sets the Associations field's value.

func (DescribeBundleAssociationsOutput) String added in v1.45.23 

func (s DescribeBundleAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeClientBrandingInput added in v1.43.30 

type DescribeClientBrandingInput struct {

	// The directory identifier of the WorkSpace for which you want to view client
	// branding information.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeClientBrandingInput) GoString added in v1.43.30 

func (s DescribeClientBrandingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeClientBrandingInput) SetResourceId added in v1.43.30 

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

SetResourceId sets the ResourceId field's value.

func (DescribeClientBrandingInput) String added in v1.43.30 

func (s DescribeClientBrandingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeClientBrandingInput) Validate added in v1.43.30 

func (s *DescribeClientBrandingInput) Validate() error

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

type DescribeClientBrandingOutput added in v1.43.30 

type DescribeClientBrandingOutput struct {

	// The branding information for Android devices.
	DeviceTypeAndroid *DefaultClientBrandingAttributes `type:"structure"`

	// The branding information for iOS devices.
	DeviceTypeIos *IosClientBrandingAttributes `type:"structure"`

	// The branding information for Linux devices.
	DeviceTypeLinux *DefaultClientBrandingAttributes `type:"structure"`

	// The branding information for macOS devices.
	DeviceTypeOsx *DefaultClientBrandingAttributes `type:"structure"`

	// The branding information for Web access.
	DeviceTypeWeb *DefaultClientBrandingAttributes `type:"structure"`

	// The branding information for Windows devices.
	DeviceTypeWindows *DefaultClientBrandingAttributes `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeClientBrandingOutput) GoString added in v1.43.30 

func (s DescribeClientBrandingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeClientBrandingOutput) SetDeviceTypeAndroid added in v1.43.30 

func (s *DescribeClientBrandingOutput) SetDeviceTypeAndroid(v *DefaultClientBrandingAttributes) *DescribeClientBrandingOutput

SetDeviceTypeAndroid sets the DeviceTypeAndroid field's value.

func (*DescribeClientBrandingOutput) SetDeviceTypeIos added in v1.43.30 

func (s *DescribeClientBrandingOutput) SetDeviceTypeIos(v *IosClientBrandingAttributes) *DescribeClientBrandingOutput

SetDeviceTypeIos sets the DeviceTypeIos field's value.

func (*DescribeClientBrandingOutput) SetDeviceTypeLinux added in v1.43.30 

func (s *DescribeClientBrandingOutput) SetDeviceTypeLinux(v *DefaultClientBrandingAttributes) *DescribeClientBrandingOutput

SetDeviceTypeLinux sets the DeviceTypeLinux field's value.

func (*DescribeClientBrandingOutput) SetDeviceTypeOsx added in v1.43.30 

func (s *DescribeClientBrandingOutput) SetDeviceTypeOsx(v *DefaultClientBrandingAttributes) *DescribeClientBrandingOutput

SetDeviceTypeOsx sets the DeviceTypeOsx field's value.

func (*DescribeClientBrandingOutput) SetDeviceTypeWeb added in v1.43.30 

func (s *DescribeClientBrandingOutput) SetDeviceTypeWeb(v *DefaultClientBrandingAttributes) *DescribeClientBrandingOutput

SetDeviceTypeWeb sets the DeviceTypeWeb field's value.

func (*DescribeClientBrandingOutput) SetDeviceTypeWindows added in v1.43.30 

func (s *DescribeClientBrandingOutput) SetDeviceTypeWindows(v *DefaultClientBrandingAttributes) *DescribeClientBrandingOutput

SetDeviceTypeWindows sets the DeviceTypeWindows field's value.

func (DescribeClientBrandingOutput) String added in v1.43.30 

func (s DescribeClientBrandingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeClientPropertiesInput added in v1.15.79 

type DescribeClientPropertiesInput struct {

	// The resource identifier, in the form of directory IDs.
	//
	// ResourceIds is a required field
	ResourceIds []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeClientPropertiesInput) GoString added in v1.15.79 

func (s DescribeClientPropertiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeClientPropertiesInput) SetResourceIds added in v1.15.79 

func (s *DescribeClientPropertiesInput) SetResourceIds(v []*string) *DescribeClientPropertiesInput

SetResourceIds sets the ResourceIds field's value.

func (DescribeClientPropertiesInput) String added in v1.15.79 

func (s DescribeClientPropertiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeClientPropertiesInput) Validate added in v1.15.79 

func (s *DescribeClientPropertiesInput) Validate() error

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

type DescribeClientPropertiesOutput added in v1.15.79 

type DescribeClientPropertiesOutput struct {

	// Information about the specified Amazon WorkSpaces clients.
	ClientPropertiesList []*ClientPropertiesResult `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeClientPropertiesOutput) GoString added in v1.15.79 

func (s DescribeClientPropertiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeClientPropertiesOutput) SetClientPropertiesList added in v1.15.79 

func (s *DescribeClientPropertiesOutput) SetClientPropertiesList(v []*ClientPropertiesResult) *DescribeClientPropertiesOutput

SetClientPropertiesList sets the ClientPropertiesList field's value.

func (DescribeClientPropertiesOutput) String added in v1.15.79 

func (s DescribeClientPropertiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeConnectClientAddInsInput added in v1.42.32 

type DescribeConnectClientAddInsInput struct {

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The directory identifier for which the client add-in is configured.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeConnectClientAddInsInput) GoString added in v1.42.32 

func (s DescribeConnectClientAddInsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectClientAddInsInput) SetMaxResults added in v1.42.32 

func (s *DescribeConnectClientAddInsInput) SetMaxResults(v int64) *DescribeConnectClientAddInsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeConnectClientAddInsInput) SetNextToken added in v1.42.32 

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

SetNextToken sets the NextToken field's value.

func (*DescribeConnectClientAddInsInput) SetResourceId added in v1.42.32 

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

SetResourceId sets the ResourceId field's value.

func (DescribeConnectClientAddInsInput) String added in v1.42.32 

func (s DescribeConnectClientAddInsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectClientAddInsInput) Validate added in v1.42.32 

func (s *DescribeConnectClientAddInsInput) Validate() error

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

type DescribeConnectClientAddInsOutput added in v1.42.32 

type DescribeConnectClientAddInsOutput struct {

	// Information about client add-ins.
	AddIns []*ConnectClientAddIn `type:"list"`

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeConnectClientAddInsOutput) GoString added in v1.42.32 

func (s DescribeConnectClientAddInsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectClientAddInsOutput) SetAddIns added in v1.42.32 

func (s *DescribeConnectClientAddInsOutput) SetAddIns(v []*ConnectClientAddIn) *DescribeConnectClientAddInsOutput

SetAddIns sets the AddIns field's value.

func (*DescribeConnectClientAddInsOutput) SetNextToken added in v1.42.32 

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

SetNextToken sets the NextToken field's value.

func (DescribeConnectClientAddInsOutput) String added in v1.42.32 

func (s DescribeConnectClientAddInsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeConnectionAliasPermissionsInput added in v1.34.22 

type DescribeConnectionAliasPermissionsInput struct {

	// The identifier of the connection alias.
	//
	// AliasId is a required field
	AliasId *string `min:"13" type:"string" required:"true"`

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeConnectionAliasPermissionsInput) GoString added in v1.34.22 

func (s DescribeConnectionAliasPermissionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectionAliasPermissionsInput) SetAliasId added in v1.34.22 

func (s *DescribeConnectionAliasPermissionsInput) SetAliasId(v string) *DescribeConnectionAliasPermissionsInput

SetAliasId sets the AliasId field's value.

func (*DescribeConnectionAliasPermissionsInput) SetMaxResults added in v1.34.22 

func (s *DescribeConnectionAliasPermissionsInput) SetMaxResults(v int64) *DescribeConnectionAliasPermissionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeConnectionAliasPermissionsInput) SetNextToken added in v1.34.22 

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

SetNextToken sets the NextToken field's value.

func (DescribeConnectionAliasPermissionsInput) String added in v1.34.22 

func (s DescribeConnectionAliasPermissionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectionAliasPermissionsInput) Validate added in v1.34.22 

func (s *DescribeConnectionAliasPermissionsInput) Validate() error

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

type DescribeConnectionAliasPermissionsOutput added in v1.34.22 

type DescribeConnectionAliasPermissionsOutput struct {

	// The identifier of the connection alias.
	AliasId *string `min:"13" type:"string"`

	// The permissions associated with a connection alias.
	ConnectionAliasPermissions []*ConnectionAliasPermission `min:"1" type:"list"`

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeConnectionAliasPermissionsOutput) GoString added in v1.34.22 

func (s DescribeConnectionAliasPermissionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectionAliasPermissionsOutput) SetAliasId added in v1.34.22 

func (s *DescribeConnectionAliasPermissionsOutput) SetAliasId(v string) *DescribeConnectionAliasPermissionsOutput

SetAliasId sets the AliasId field's value.

func (*DescribeConnectionAliasPermissionsOutput) SetConnectionAliasPermissions added in v1.34.22 

func (s *DescribeConnectionAliasPermissionsOutput) SetConnectionAliasPermissions(v []*ConnectionAliasPermission) *DescribeConnectionAliasPermissionsOutput

SetConnectionAliasPermissions sets the ConnectionAliasPermissions field's value.

func (*DescribeConnectionAliasPermissionsOutput) SetNextToken added in v1.34.22 

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

SetNextToken sets the NextToken field's value.

func (DescribeConnectionAliasPermissionsOutput) String added in v1.34.22 

func (s DescribeConnectionAliasPermissionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeConnectionAliasesInput added in v1.34.22 

type DescribeConnectionAliasesInput struct {

	// The identifiers of the connection aliases to describe.
	AliasIds []*string `min:"1" type:"list"`

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The identifier of the directory associated with the connection alias.
	ResourceId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeConnectionAliasesInput) GoString added in v1.34.22 

func (s DescribeConnectionAliasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectionAliasesInput) SetAliasIds added in v1.34.22 

func (s *DescribeConnectionAliasesInput) SetAliasIds(v []*string) *DescribeConnectionAliasesInput

SetAliasIds sets the AliasIds field's value.

func (*DescribeConnectionAliasesInput) SetLimit added in v1.34.22 

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

SetLimit sets the Limit field's value.

func (*DescribeConnectionAliasesInput) SetNextToken added in v1.34.22 

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

SetNextToken sets the NextToken field's value.

func (*DescribeConnectionAliasesInput) SetResourceId added in v1.34.22 

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

SetResourceId sets the ResourceId field's value.

func (DescribeConnectionAliasesInput) String added in v1.34.22 

func (s DescribeConnectionAliasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectionAliasesInput) Validate added in v1.34.22 

func (s *DescribeConnectionAliasesInput) Validate() error

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

type DescribeConnectionAliasesOutput added in v1.34.22 

type DescribeConnectionAliasesOutput struct {

	// Information about the specified connection aliases.
	ConnectionAliases []*ConnectionAlias `min:"1" type:"list"`

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeConnectionAliasesOutput) GoString added in v1.34.22 

func (s DescribeConnectionAliasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeConnectionAliasesOutput) SetConnectionAliases added in v1.34.22 

func (s *DescribeConnectionAliasesOutput) SetConnectionAliases(v []*ConnectionAlias) *DescribeConnectionAliasesOutput

SetConnectionAliases sets the ConnectionAliases field's value.

func (*DescribeConnectionAliasesOutput) SetNextToken added in v1.34.22 

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

SetNextToken sets the NextToken field's value.

func (DescribeConnectionAliasesOutput) String added in v1.34.22 

func (s DescribeConnectionAliasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeImageAssociationsInput added in v1.45.23 

type DescribeImageAssociationsInput struct {

	// The resource types of the associated resource.
	//
	// AssociatedResourceTypes is a required field
	AssociatedResourceTypes []*string `type:"list" required:"true" enum:"ImageAssociatedResourceType"`

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

func (DescribeImageAssociationsInput) GoString added in v1.45.23 

func (s DescribeImageAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeImageAssociationsInput) SetAssociatedResourceTypes added in v1.45.23 

func (s *DescribeImageAssociationsInput) SetAssociatedResourceTypes(v []*string) *DescribeImageAssociationsInput

SetAssociatedResourceTypes sets the AssociatedResourceTypes field's value.

func (*DescribeImageAssociationsInput) SetImageId added in v1.45.23 

func (s *DescribeImageAssociationsInput) SetImageId(v string) *DescribeImageAssociationsInput

SetImageId sets the ImageId field's value.

func (DescribeImageAssociationsInput) String added in v1.45.23 

func (s DescribeImageAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeImageAssociationsInput) Validate added in v1.45.23 

func (s *DescribeImageAssociationsInput) Validate() error

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

type DescribeImageAssociationsOutput added in v1.45.23 

type DescribeImageAssociationsOutput struct {

	// List of information about the specified associations.
	Associations []*ImageResourceAssociation `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeImageAssociationsOutput) GoString added in v1.45.23 

func (s DescribeImageAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeImageAssociationsOutput) SetAssociations added in v1.45.23 

func (s *DescribeImageAssociationsOutput) SetAssociations(v []*ImageResourceAssociation) *DescribeImageAssociationsOutput

SetAssociations sets the Associations field's value.

func (DescribeImageAssociationsOutput) String added in v1.45.23 

func (s DescribeImageAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeIpGroupsInput added in v1.13.39 

type DescribeIpGroupsInput struct {

	// The identifiers of one or more IP access control groups.
	GroupIds []*string `type:"list"`

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeIpGroupsInput) GoString added in v1.13.39 

func (s DescribeIpGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIpGroupsInput) SetGroupIds added in v1.13.39 

func (s *DescribeIpGroupsInput) SetGroupIds(v []*string) *DescribeIpGroupsInput

SetGroupIds sets the GroupIds field's value.

func (*DescribeIpGroupsInput) SetMaxResults added in v1.13.39 

func (s *DescribeIpGroupsInput) SetMaxResults(v int64) *DescribeIpGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeIpGroupsInput) SetNextToken added in v1.13.39 

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

SetNextToken sets the NextToken field's value.

func (DescribeIpGroupsInput) String added in v1.13.39 

func (s DescribeIpGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIpGroupsInput) Validate added in v1.13.39 

func (s *DescribeIpGroupsInput) Validate() error

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

type DescribeIpGroupsOutput added in v1.13.39 

type DescribeIpGroupsOutput struct {

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`

	// Information about the IP access control groups.
	Result []*IpGroup `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeIpGroupsOutput) GoString added in v1.13.39 

func (s DescribeIpGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeIpGroupsOutput) SetNextToken added in v1.13.39 

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

SetNextToken sets the NextToken field's value.

func (*DescribeIpGroupsOutput) SetResult added in v1.13.39 

func (s *DescribeIpGroupsOutput) SetResult(v []*IpGroup) *DescribeIpGroupsOutput

SetResult sets the Result field's value.

func (DescribeIpGroupsOutput) String added in v1.13.39 

func (s DescribeIpGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTagsInput added in v1.1.27 

type DescribeTagsInput struct {

	// The identifier of the WorkSpaces resource. The supported resource types are
	// WorkSpaces, registered directories, images, custom bundles, IP access control
	// groups, and connection aliases.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTagsInput) GoString added in v1.1.27 

func (s DescribeTagsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTagsInput) SetResourceId added in v1.5.0 

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

SetResourceId sets the ResourceId field's value.

func (DescribeTagsInput) String added in v1.1.27 

func (s DescribeTagsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTagsInput) Validate added in v1.1.27 

func (s *DescribeTagsInput) Validate() error

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

type DescribeTagsOutput added in v1.1.27 

type DescribeTagsOutput struct {

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

func (DescribeTagsOutput) GoString added in v1.1.27 

func (s DescribeTagsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTagsOutput) SetTagList added in v1.5.0 

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

SetTagList sets the TagList field's value.

func (DescribeTagsOutput) String added in v1.1.27 

func (s DescribeTagsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspaceAssociationsInput added in v1.45.23 

type DescribeWorkspaceAssociationsInput struct {

	// The resource types of the associated resources.
	//
	// AssociatedResourceTypes is a required field
	AssociatedResourceTypes []*string `type:"list" required:"true" enum:"WorkSpaceAssociatedResourceType"`

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

func (DescribeWorkspaceAssociationsInput) GoString added in v1.45.23 

func (s DescribeWorkspaceAssociationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceAssociationsInput) SetAssociatedResourceTypes added in v1.45.23 

func (s *DescribeWorkspaceAssociationsInput) SetAssociatedResourceTypes(v []*string) *DescribeWorkspaceAssociationsInput

SetAssociatedResourceTypes sets the AssociatedResourceTypes field's value.

func (*DescribeWorkspaceAssociationsInput) SetWorkspaceId added in v1.45.23 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (DescribeWorkspaceAssociationsInput) String added in v1.45.23 

func (s DescribeWorkspaceAssociationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceAssociationsInput) Validate added in v1.45.23 

func (s *DescribeWorkspaceAssociationsInput) Validate() error

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

type DescribeWorkspaceAssociationsOutput added in v1.45.23 

type DescribeWorkspaceAssociationsOutput struct {

	// List of information about the specified associations.
	Associations []*WorkspaceResourceAssociation `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceAssociationsOutput) GoString added in v1.45.23 

func (s DescribeWorkspaceAssociationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceAssociationsOutput) SetAssociations added in v1.45.23 

func (s *DescribeWorkspaceAssociationsOutput) SetAssociations(v []*WorkspaceResourceAssociation) *DescribeWorkspaceAssociationsOutput

SetAssociations sets the Associations field's value.

func (DescribeWorkspaceAssociationsOutput) String added in v1.45.23 

func (s DescribeWorkspaceAssociationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspaceBundlesInput 

type DescribeWorkspaceBundlesInput struct {

	// The identifiers of the bundles. You cannot combine this parameter with any
	// other filter.
	BundleIds []*string `min:"1" type:"list"`

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

	// The owner of the bundles. You cannot combine this parameter with any other
	// filter.
	//
	// To describe the bundles provided by Amazon Web Services, specify AMAZON.
	// To describe the bundles that belong to your account, don't specify a value.
	Owner *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceBundlesInput) GoString added in v0.6.5 

func (s DescribeWorkspaceBundlesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceBundlesInput) SetBundleIds added in v1.5.0 

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

SetBundleIds sets the BundleIds field's value.

func (*DescribeWorkspaceBundlesInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspaceBundlesInput) SetOwner added in v1.5.0 

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

SetOwner sets the Owner field's value.

func (DescribeWorkspaceBundlesInput) String added in v0.6.5 

func (s DescribeWorkspaceBundlesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceBundlesInput) Validate added in v1.1.21 

func (s *DescribeWorkspaceBundlesInput) Validate() error

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

type DescribeWorkspaceBundlesOutput 

type DescribeWorkspaceBundlesOutput struct {

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

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

func (DescribeWorkspaceBundlesOutput) GoString added in v0.6.5 

func (s DescribeWorkspaceBundlesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceBundlesOutput) SetBundles added in v1.5.0 

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

SetBundles sets the Bundles field's value.

func (*DescribeWorkspaceBundlesOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceBundlesOutput) String added in v0.6.5 

func (s DescribeWorkspaceBundlesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspaceDirectoriesInput 

type DescribeWorkspaceDirectoriesInput struct {

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

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceDirectoriesInput) GoString added in v0.6.5 

func (s DescribeWorkspaceDirectoriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceDirectoriesInput) SetDirectoryIds added in v1.5.0 

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

SetDirectoryIds sets the DirectoryIds field's value.

func (*DescribeWorkspaceDirectoriesInput) SetLimit added in v1.25.36 

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

SetLimit sets the Limit field's value.

func (*DescribeWorkspaceDirectoriesInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceDirectoriesInput) String added in v0.6.5 

func (s DescribeWorkspaceDirectoriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceDirectoriesInput) Validate added in v1.1.21 

func (s *DescribeWorkspaceDirectoriesInput) Validate() error

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

type DescribeWorkspaceDirectoriesOutput 

type DescribeWorkspaceDirectoriesOutput struct {

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

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceDirectoriesOutput) GoString added in v0.6.5 

func (s DescribeWorkspaceDirectoriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceDirectoriesOutput) SetDirectories added in v1.5.0 

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

SetDirectories sets the Directories field's value.

func (*DescribeWorkspaceDirectoriesOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceDirectoriesOutput) String added in v0.6.5 

func (s DescribeWorkspaceDirectoriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspaceImagePermissionsInput added in v1.33.11 

type DescribeWorkspaceImagePermissionsInput struct {

	// The identifier of the image.
	//
	// ImageId is a required field
	ImageId *string `type:"string" required:"true"`

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceImagePermissionsInput) GoString added in v1.33.11 

func (s DescribeWorkspaceImagePermissionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceImagePermissionsInput) SetImageId added in v1.33.11 

func (s *DescribeWorkspaceImagePermissionsInput) SetImageId(v string) *DescribeWorkspaceImagePermissionsInput

SetImageId sets the ImageId field's value.

func (*DescribeWorkspaceImagePermissionsInput) SetMaxResults added in v1.33.11 

func (s *DescribeWorkspaceImagePermissionsInput) SetMaxResults(v int64) *DescribeWorkspaceImagePermissionsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeWorkspaceImagePermissionsInput) SetNextToken added in v1.33.11 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceImagePermissionsInput) String added in v1.33.11 

func (s DescribeWorkspaceImagePermissionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceImagePermissionsInput) Validate added in v1.33.11 

func (s *DescribeWorkspaceImagePermissionsInput) Validate() error

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

type DescribeWorkspaceImagePermissionsOutput added in v1.33.11 

type DescribeWorkspaceImagePermissionsOutput struct {

	// The identifier of the image.
	ImageId *string `type:"string"`

	// The identifiers of the Amazon Web Services accounts that the image has been
	// shared with.
	ImagePermissions []*ImagePermission `type:"list"`

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceImagePermissionsOutput) GoString added in v1.33.11 

func (s DescribeWorkspaceImagePermissionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceImagePermissionsOutput) SetImageId added in v1.33.11 

func (s *DescribeWorkspaceImagePermissionsOutput) SetImageId(v string) *DescribeWorkspaceImagePermissionsOutput

SetImageId sets the ImageId field's value.

func (*DescribeWorkspaceImagePermissionsOutput) SetImagePermissions added in v1.33.11 

func (s *DescribeWorkspaceImagePermissionsOutput) SetImagePermissions(v []*ImagePermission) *DescribeWorkspaceImagePermissionsOutput

SetImagePermissions sets the ImagePermissions field's value.

func (*DescribeWorkspaceImagePermissionsOutput) SetNextToken added in v1.33.11 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceImagePermissionsOutput) String added in v1.33.11 

func (s DescribeWorkspaceImagePermissionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspaceImagesInput added in v1.15.78 

type DescribeWorkspaceImagesInput struct {

	// The identifier of the image.
	ImageIds []*string `min:"1" type:"list"`

	// The type (owned or shared) of the image.
	ImageType *string `type:"string" enum:"ImageType"`

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceImagesInput) GoString added in v1.15.78 

func (s DescribeWorkspaceImagesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceImagesInput) SetImageIds added in v1.15.78 

func (s *DescribeWorkspaceImagesInput) SetImageIds(v []*string) *DescribeWorkspaceImagesInput

SetImageIds sets the ImageIds field's value.

func (*DescribeWorkspaceImagesInput) SetImageType added in v1.33.11 

func (s *DescribeWorkspaceImagesInput) SetImageType(v string) *DescribeWorkspaceImagesInput

SetImageType sets the ImageType field's value.

func (*DescribeWorkspaceImagesInput) SetMaxResults added in v1.15.78 

func (s *DescribeWorkspaceImagesInput) SetMaxResults(v int64) *DescribeWorkspaceImagesInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeWorkspaceImagesInput) SetNextToken added in v1.15.78 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceImagesInput) String added in v1.15.78 

func (s DescribeWorkspaceImagesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceImagesInput) Validate added in v1.15.78 

func (s *DescribeWorkspaceImagesInput) Validate() error

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

type DescribeWorkspaceImagesOutput added in v1.15.78 

type DescribeWorkspaceImagesOutput struct {

	// Information about the images.
	Images []*WorkspaceImage `type:"list"`

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceImagesOutput) GoString added in v1.15.78 

func (s DescribeWorkspaceImagesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceImagesOutput) SetImages added in v1.15.78 

func (s *DescribeWorkspaceImagesOutput) SetImages(v []*WorkspaceImage) *DescribeWorkspaceImagesOutput

SetImages sets the Images field's value.

func (*DescribeWorkspaceImagesOutput) SetNextToken added in v1.15.78 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceImagesOutput) String added in v1.15.78 

func (s DescribeWorkspaceImagesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspaceSnapshotsInput added in v1.20.11 

type DescribeWorkspaceSnapshotsInput struct {

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

func (DescribeWorkspaceSnapshotsInput) GoString added in v1.20.11 

func (s DescribeWorkspaceSnapshotsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceSnapshotsInput) SetWorkspaceId added in v1.20.11 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (DescribeWorkspaceSnapshotsInput) String added in v1.20.11 

func (s DescribeWorkspaceSnapshotsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceSnapshotsInput) Validate added in v1.20.11 

func (s *DescribeWorkspaceSnapshotsInput) Validate() error

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

type DescribeWorkspaceSnapshotsOutput added in v1.20.11 

type DescribeWorkspaceSnapshotsOutput struct {

	// Information about the snapshots that can be used to rebuild a WorkSpace.
	// These snapshots include the user volume.
	RebuildSnapshots []*Snapshot `type:"list"`

	// Information about the snapshots that can be used to restore a WorkSpace.
	// These snapshots include both the root volume and the user volume.
	RestoreSnapshots []*Snapshot `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceSnapshotsOutput) GoString added in v1.20.11 

func (s DescribeWorkspaceSnapshotsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceSnapshotsOutput) SetRebuildSnapshots added in v1.20.11 

func (s *DescribeWorkspaceSnapshotsOutput) SetRebuildSnapshots(v []*Snapshot) *DescribeWorkspaceSnapshotsOutput

SetRebuildSnapshots sets the RebuildSnapshots field's value.

func (*DescribeWorkspaceSnapshotsOutput) SetRestoreSnapshots added in v1.20.11 

func (s *DescribeWorkspaceSnapshotsOutput) SetRestoreSnapshots(v []*Snapshot) *DescribeWorkspaceSnapshotsOutput

SetRestoreSnapshots sets the RestoreSnapshots field's value.

func (DescribeWorkspaceSnapshotsOutput) String added in v1.20.11 

func (s DescribeWorkspaceSnapshotsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspacesConnectionStatusInput added in v1.4.3 

type DescribeWorkspacesConnectionStatusInput struct {

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`

	// The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
	WorkspaceIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeWorkspacesConnectionStatusInput) GoString added in v1.4.3 

func (s DescribeWorkspacesConnectionStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspacesConnectionStatusInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspacesConnectionStatusInput) SetWorkspaceIds added in v1.5.0 

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

SetWorkspaceIds sets the WorkspaceIds field's value.

func (DescribeWorkspacesConnectionStatusInput) String added in v1.4.3 

func (s DescribeWorkspacesConnectionStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspacesConnectionStatusInput) Validate added in v1.4.3 

func (s *DescribeWorkspacesConnectionStatusInput) Validate() error

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

type DescribeWorkspacesConnectionStatusOutput added in v1.4.3 

type DescribeWorkspacesConnectionStatusOutput struct {

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`

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

func (DescribeWorkspacesConnectionStatusOutput) GoString added in v1.4.3 

func (s DescribeWorkspacesConnectionStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspacesConnectionStatusOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspacesConnectionStatusOutput) SetWorkspacesConnectionStatus added in v1.5.0 

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

SetWorkspacesConnectionStatus sets the WorkspacesConnectionStatus field's value.

func (DescribeWorkspacesConnectionStatusOutput) String added in v1.4.3 

func (s DescribeWorkspacesConnectionStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspacesInput 

type DescribeWorkspacesInput struct {

	// The identifier of the bundle. All WorkSpaces that are created from this bundle
	// are retrieved. You cannot combine this parameter with any other filter.
	BundleId *string `type:"string"`

	// The identifier of the directory. In addition, you can optionally specify
	// a specific directory user (see UserName). You cannot combine this parameter
	// with any other filter.
	DirectoryId *string `min:"10" type:"string"`

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`

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

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

func (DescribeWorkspacesInput) GoString added in v0.6.5 

func (s DescribeWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspacesInput) SetBundleId added in v1.5.0 

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

SetBundleId sets the BundleId field's value.

func (*DescribeWorkspacesInput) SetDirectoryId added in v1.5.0 

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

SetDirectoryId sets the DirectoryId field's value.

func (*DescribeWorkspacesInput) SetLimit added in v1.5.0 

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

SetLimit sets the Limit field's value.

func (*DescribeWorkspacesInput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspacesInput) SetUserName added in v1.5.0 

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

SetUserName sets the UserName field's value.

func (*DescribeWorkspacesInput) SetWorkspaceIds added in v1.5.0 

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

SetWorkspaceIds sets the WorkspaceIds field's value.

func (DescribeWorkspacesInput) String added in v0.6.5 

func (s DescribeWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspacesInput) Validate added in v1.1.21 

func (s *DescribeWorkspacesInput) Validate() error

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

type DescribeWorkspacesOutput 

type DescribeWorkspacesOutput struct {

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`

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

func (DescribeWorkspacesOutput) GoString added in v0.6.5 

func (s DescribeWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspacesOutput) SetNextToken added in v1.5.0 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspacesOutput) SetWorkspaces added in v1.5.0 

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

SetWorkspaces sets the Workspaces field's value.

func (DescribeWorkspacesOutput) String added in v0.6.5 

func (s DescribeWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateConnectionAliasInput added in v1.34.22 

type DisassociateConnectionAliasInput struct {

	// The identifier of the connection alias to disassociate.
	//
	// AliasId is a required field
	AliasId *string `min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateConnectionAliasInput) GoString added in v1.34.22 

func (s DisassociateConnectionAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateConnectionAliasInput) SetAliasId added in v1.34.22 

func (s *DisassociateConnectionAliasInput) SetAliasId(v string) *DisassociateConnectionAliasInput

SetAliasId sets the AliasId field's value.

func (DisassociateConnectionAliasInput) String added in v1.34.22 

func (s DisassociateConnectionAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateConnectionAliasInput) Validate added in v1.34.22 

func (s *DisassociateConnectionAliasInput) Validate() error

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

type DisassociateConnectionAliasOutput added in v1.34.22 

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

func (DisassociateConnectionAliasOutput) GoString added in v1.34.22 

func (s DisassociateConnectionAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateConnectionAliasOutput) String added in v1.34.22 

func (s DisassociateConnectionAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateIpGroupsInput added in v1.13.39 

type DisassociateIpGroupsInput struct {

	// The identifier of the directory.
	//
	// DirectoryId is a required field
	DirectoryId *string `min:"10" type:"string" required:"true"`

	// The identifiers of one or more IP access control groups.
	//
	// GroupIds is a required field
	GroupIds []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateIpGroupsInput) GoString added in v1.13.39 

func (s DisassociateIpGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateIpGroupsInput) SetDirectoryId added in v1.13.39 

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

SetDirectoryId sets the DirectoryId field's value.

func (*DisassociateIpGroupsInput) SetGroupIds added in v1.13.39 

func (s *DisassociateIpGroupsInput) SetGroupIds(v []*string) *DisassociateIpGroupsInput

SetGroupIds sets the GroupIds field's value.

func (DisassociateIpGroupsInput) String added in v1.13.39 

func (s DisassociateIpGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateIpGroupsInput) Validate added in v1.13.39 

func (s *DisassociateIpGroupsInput) Validate() error

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

type DisassociateIpGroupsOutput added in v1.13.39 

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

func (DisassociateIpGroupsOutput) GoString added in v1.13.39 

func (s DisassociateIpGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateIpGroupsOutput) String added in v1.13.39 

func (s DisassociateIpGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateWorkspaceApplicationInput added in v1.45.23 

type DisassociateWorkspaceApplicationInput struct {

	// The identifier of the application.
	//
	// ApplicationId is a required field
	ApplicationId *string `type:"string" required:"true"`

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

func (DisassociateWorkspaceApplicationInput) GoString added in v1.45.23 

func (s DisassociateWorkspaceApplicationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateWorkspaceApplicationInput) SetApplicationId added in v1.45.23 

func (s *DisassociateWorkspaceApplicationInput) SetApplicationId(v string) *DisassociateWorkspaceApplicationInput

SetApplicationId sets the ApplicationId field's value.

func (*DisassociateWorkspaceApplicationInput) SetWorkspaceId added in v1.45.23 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (DisassociateWorkspaceApplicationInput) String added in v1.45.23 

func (s DisassociateWorkspaceApplicationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateWorkspaceApplicationInput) Validate added in v1.45.23 

func (s *DisassociateWorkspaceApplicationInput) Validate() error

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

type DisassociateWorkspaceApplicationOutput added in v1.45.23 

type DisassociateWorkspaceApplicationOutput struct {

	// Information about the targeted association.
	Association *WorkspaceResourceAssociation `type:"structure"`
	// contains filtered or unexported fields
}

func (DisassociateWorkspaceApplicationOutput) GoString added in v1.45.23 

func (s DisassociateWorkspaceApplicationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateWorkspaceApplicationOutput) SetAssociation added in v1.45.23 

func (s *DisassociateWorkspaceApplicationOutput) SetAssociation(v *WorkspaceResourceAssociation) *DisassociateWorkspaceApplicationOutput

SetAssociation sets the Association field's value.

func (DisassociateWorkspaceApplicationOutput) String added in v1.45.23 

func (s DisassociateWorkspaceApplicationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ErrorDetails added in v1.45.6 

type ErrorDetails struct {

	// Indicates the error code returned.
	ErrorCode *string `type:"string" enum:"WorkspaceImageErrorDetailCode"`

	// The text of the error message related the error code.
	ErrorMessage *string `type:"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.

func (ErrorDetails) GoString added in v1.45.6 

func (s ErrorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ErrorDetails) SetErrorCode added in v1.45.6 

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

SetErrorCode sets the ErrorCode field's value.

func (*ErrorDetails) SetErrorMessage added in v1.45.6 

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

SetErrorMessage sets the ErrorMessage field's value.

func (ErrorDetails) String added in v1.45.6 

func (s ErrorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailedCreateStandbyWorkspacesRequest added in v1.44.140 

type FailedCreateStandbyWorkspacesRequest struct {

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

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

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

Describes the standby WorkSpace that could not be created.

func (FailedCreateStandbyWorkspacesRequest) GoString added in v1.44.140 

func (s FailedCreateStandbyWorkspacesRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailedCreateStandbyWorkspacesRequest) SetErrorCode added in v1.44.140 

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

SetErrorCode sets the ErrorCode field's value.

func (*FailedCreateStandbyWorkspacesRequest) SetErrorMessage added in v1.44.140 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*FailedCreateStandbyWorkspacesRequest) SetStandbyWorkspaceRequest added in v1.44.140 

func (s *FailedCreateStandbyWorkspacesRequest) SetStandbyWorkspaceRequest(v *StandbyWorkspace) *FailedCreateStandbyWorkspacesRequest

SetStandbyWorkspaceRequest sets the StandbyWorkspaceRequest field's value.

func (FailedCreateStandbyWorkspacesRequest) String added in v1.44.140 

func (s FailedCreateStandbyWorkspacesRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailedCreateWorkspaceRequest 

type FailedCreateWorkspaceRequest struct {

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

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

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

Describes a WorkSpace that cannot be created.

func (FailedCreateWorkspaceRequest) GoString added in v0.6.5 

func (s FailedCreateWorkspaceRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailedCreateWorkspaceRequest) SetErrorCode added in v1.5.0 

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

SetErrorCode sets the ErrorCode field's value.

func (*FailedCreateWorkspaceRequest) SetErrorMessage added in v1.5.0 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*FailedCreateWorkspaceRequest) SetWorkspaceRequest added in v1.5.0 

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

SetWorkspaceRequest sets the WorkspaceRequest field's value.

func (FailedCreateWorkspaceRequest) String added in v0.6.5 

func (s FailedCreateWorkspaceRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FailedWorkspaceChangeRequest 

type FailedWorkspaceChangeRequest struct {

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

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

	// The identifier of the WorkSpace.
	WorkspaceId *string `type:"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).

func (FailedWorkspaceChangeRequest) GoString added in v0.6.5 

func (s FailedWorkspaceChangeRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FailedWorkspaceChangeRequest) SetErrorCode added in v1.5.0 

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

SetErrorCode sets the ErrorCode field's value.

func (*FailedWorkspaceChangeRequest) SetErrorMessage added in v1.5.0 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*FailedWorkspaceChangeRequest) SetWorkspaceId added in v1.5.0 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (FailedWorkspaceChangeRequest) String added in v0.6.5 

func (s FailedWorkspaceChangeRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImagePermission added in v1.33.11 

type ImagePermission struct {

	// The identifier of the Amazon Web Services account that an image has been
	// shared with.
	SharedAccountId *string `type:"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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html).

func (ImagePermission) GoString added in v1.33.11 

func (s ImagePermission) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImagePermission) SetSharedAccountId added in v1.33.11 

func (s *ImagePermission) SetSharedAccountId(v string) *ImagePermission

SetSharedAccountId sets the SharedAccountId field's value.

func (ImagePermission) String added in v1.33.11 

func (s ImagePermission) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImageResourceAssociation added in v1.45.23 

type ImageResourceAssociation struct {

	// The identifier of the associated resource.
	AssociatedResourceId *string `min:"1" type:"string"`

	// The resource type of the associated resources.
	AssociatedResourceType *string `type:"string" enum:"ImageAssociatedResourceType"`

	// The time the association is created.
	Created *time.Time `type:"timestamp"`

	// The identifier of the image.
	ImageId *string `type:"string"`

	// The time the association status was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// The status of the image resource association.
	State *string `type:"string" enum:"AssociationState"`

	// The reason the association deployment failed.
	StateReason *AssociationStateReason `type:"structure"`
	// contains filtered or unexported fields
}

Describes the association between an application and an image resource.

func (ImageResourceAssociation) GoString added in v1.45.23 

func (s ImageResourceAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageResourceAssociation) SetAssociatedResourceId added in v1.45.23 

func (s *ImageResourceAssociation) SetAssociatedResourceId(v string) *ImageResourceAssociation

SetAssociatedResourceId sets the AssociatedResourceId field's value.

func (*ImageResourceAssociation) SetAssociatedResourceType added in v1.45.23 

func (s *ImageResourceAssociation) SetAssociatedResourceType(v string) *ImageResourceAssociation

SetAssociatedResourceType sets the AssociatedResourceType field's value.

func (*ImageResourceAssociation) SetCreated added in v1.45.23 

func (s *ImageResourceAssociation) SetCreated(v time.Time) *ImageResourceAssociation

SetCreated sets the Created field's value.

func (*ImageResourceAssociation) SetImageId added in v1.45.23 

func (s *ImageResourceAssociation) SetImageId(v string) *ImageResourceAssociation

SetImageId sets the ImageId field's value.

func (*ImageResourceAssociation) SetLastUpdatedTime added in v1.45.23 

func (s *ImageResourceAssociation) SetLastUpdatedTime(v time.Time) *ImageResourceAssociation

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*ImageResourceAssociation) SetState added in v1.45.23 

func (s *ImageResourceAssociation) SetState(v string) *ImageResourceAssociation

SetState sets the State field's value.

func (*ImageResourceAssociation) SetStateReason added in v1.45.23 

func (s *ImageResourceAssociation) SetStateReason(v *AssociationStateReason) *ImageResourceAssociation

SetStateReason sets the StateReason field's value.

func (ImageResourceAssociation) String added in v1.45.23 

func (s ImageResourceAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportClientBrandingInput added in v1.43.30 

type ImportClientBrandingInput struct {

	// The branding information to import for Android devices.
	DeviceTypeAndroid *DefaultImportClientBrandingAttributes `type:"structure"`

	// The branding information to import for iOS devices.
	DeviceTypeIos *IosImportClientBrandingAttributes `type:"structure"`

	// The branding information to import for Linux devices.
	DeviceTypeLinux *DefaultImportClientBrandingAttributes `type:"structure"`

	// The branding information to import for macOS devices.
	DeviceTypeOsx *DefaultImportClientBrandingAttributes `type:"structure"`

	// The branding information to import for web access.
	DeviceTypeWeb *DefaultImportClientBrandingAttributes `type:"structure"`

	// The branding information to import for Windows devices.
	DeviceTypeWindows *DefaultImportClientBrandingAttributes `type:"structure"`

	// The directory identifier of the WorkSpace for which you want to import client
	// branding.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ImportClientBrandingInput) GoString added in v1.43.30 

func (s ImportClientBrandingInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportClientBrandingInput) SetDeviceTypeAndroid added in v1.43.30 

func (s *ImportClientBrandingInput) SetDeviceTypeAndroid(v *DefaultImportClientBrandingAttributes) *ImportClientBrandingInput

SetDeviceTypeAndroid sets the DeviceTypeAndroid field's value.

func (*ImportClientBrandingInput) SetDeviceTypeIos added in v1.43.30 

func (s *ImportClientBrandingInput) SetDeviceTypeIos(v *IosImportClientBrandingAttributes) *ImportClientBrandingInput

SetDeviceTypeIos sets the DeviceTypeIos field's value.

func (*ImportClientBrandingInput) SetDeviceTypeLinux added in v1.43.30 

func (s *ImportClientBrandingInput) SetDeviceTypeLinux(v *DefaultImportClientBrandingAttributes) *ImportClientBrandingInput

SetDeviceTypeLinux sets the DeviceTypeLinux field's value.

func (*ImportClientBrandingInput) SetDeviceTypeOsx added in v1.43.30 

func (s *ImportClientBrandingInput) SetDeviceTypeOsx(v *DefaultImportClientBrandingAttributes) *ImportClientBrandingInput

SetDeviceTypeOsx sets the DeviceTypeOsx field's value.

func (*ImportClientBrandingInput) SetDeviceTypeWeb added in v1.43.30 

func (s *ImportClientBrandingInput) SetDeviceTypeWeb(v *DefaultImportClientBrandingAttributes) *ImportClientBrandingInput

SetDeviceTypeWeb sets the DeviceTypeWeb field's value.

func (*ImportClientBrandingInput) SetDeviceTypeWindows added in v1.43.30 

func (s *ImportClientBrandingInput) SetDeviceTypeWindows(v *DefaultImportClientBrandingAttributes) *ImportClientBrandingInput

SetDeviceTypeWindows sets the DeviceTypeWindows field's value.

func (*ImportClientBrandingInput) SetResourceId added in v1.43.30 

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

SetResourceId sets the ResourceId field's value.

func (ImportClientBrandingInput) String added in v1.43.30 

func (s ImportClientBrandingInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportClientBrandingInput) Validate added in v1.43.30 

func (s *ImportClientBrandingInput) Validate() error

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

type ImportClientBrandingOutput added in v1.43.30 

type ImportClientBrandingOutput struct {

	// The branding information configured for Android devices.
	DeviceTypeAndroid *DefaultClientBrandingAttributes `type:"structure"`

	// The branding information configured for iOS devices.
	DeviceTypeIos *IosClientBrandingAttributes `type:"structure"`

	// The branding information configured for Linux devices.
	DeviceTypeLinux *DefaultClientBrandingAttributes `type:"structure"`

	// The branding information configured for macOS devices.
	DeviceTypeOsx *DefaultClientBrandingAttributes `type:"structure"`

	// The branding information configured for web access.
	DeviceTypeWeb *DefaultClientBrandingAttributes `type:"structure"`

	// The branding information configured for Windows devices.
	DeviceTypeWindows *DefaultClientBrandingAttributes `type:"structure"`
	// contains filtered or unexported fields
}

func (ImportClientBrandingOutput) GoString added in v1.43.30 

func (s ImportClientBrandingOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportClientBrandingOutput) SetDeviceTypeAndroid added in v1.43.30 

func (s *ImportClientBrandingOutput) SetDeviceTypeAndroid(v *DefaultClientBrandingAttributes) *ImportClientBrandingOutput

SetDeviceTypeAndroid sets the DeviceTypeAndroid field's value.

func (*ImportClientBrandingOutput) SetDeviceTypeIos added in v1.43.30 

func (s *ImportClientBrandingOutput) SetDeviceTypeIos(v *IosClientBrandingAttributes) *ImportClientBrandingOutput

SetDeviceTypeIos sets the DeviceTypeIos field's value.

func (*ImportClientBrandingOutput) SetDeviceTypeLinux added in v1.43.30 

func (s *ImportClientBrandingOutput) SetDeviceTypeLinux(v *DefaultClientBrandingAttributes) *ImportClientBrandingOutput

SetDeviceTypeLinux sets the DeviceTypeLinux field's value.

func (*ImportClientBrandingOutput) SetDeviceTypeOsx added in v1.43.30 

func (s *ImportClientBrandingOutput) SetDeviceTypeOsx(v *DefaultClientBrandingAttributes) *ImportClientBrandingOutput

SetDeviceTypeOsx sets the DeviceTypeOsx field's value.

func (*ImportClientBrandingOutput) SetDeviceTypeWeb added in v1.43.30 

func (s *ImportClientBrandingOutput) SetDeviceTypeWeb(v *DefaultClientBrandingAttributes) *ImportClientBrandingOutput

SetDeviceTypeWeb sets the DeviceTypeWeb field's value.

func (*ImportClientBrandingOutput) SetDeviceTypeWindows added in v1.43.30 

func (s *ImportClientBrandingOutput) SetDeviceTypeWindows(v *DefaultClientBrandingAttributes) *ImportClientBrandingOutput

SetDeviceTypeWindows sets the DeviceTypeWindows field's value.

func (ImportClientBrandingOutput) String added in v1.43.30 

func (s ImportClientBrandingOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportWorkspaceImageInput added in v1.15.78 

type ImportWorkspaceImageInput struct {

	// If specified, the version of Microsoft Office to subscribe to. Valid only
	// for Windows 10 and 11 BYOL images. For more information about subscribing
	// to Office for BYOL images, see Bring Your Own Windows Desktop Licenses (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html).
	//
	//    * Although this parameter is an array, only one item is allowed at this
	//    time.
	//
	//    * Windows 11 only supports Microsoft_Office_2019.
	Applications []*string `min:"1" type:"list" enum:"Application"`

	// The identifier of the EC2 image.
	//
	// Ec2ImageId is a required field
	Ec2ImageId *string `type:"string" required:"true"`

	// The description of the WorkSpace image.
	//
	// ImageDescription is a required field
	ImageDescription *string `min:"1" type:"string" required:"true"`

	// The name of the WorkSpace image.
	//
	// ImageName is a required field
	ImageName *string `min:"1" type:"string" required:"true"`

	// The ingestion process to be used when importing the image, depending on which
	// protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces
	// Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP,
	// specify a value that ends in _WSP. To use PCoIP, specify a value that does
	// not end in _WSP. To use BYOP, specify a value that ends in _BYOP.
	//
	// For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro),
	// specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on
	// the protocol.
	//
	// The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported
	// by Amazon WorkSpaces Core. Contact your account team to be allow-listed to
	// use these values. For more information, see Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/).
	//
	// IngestionProcess is a required field
	IngestionProcess *string `type:"string" required:"true" enum:"WorkspaceImageIngestionProcess"`

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

func (ImportWorkspaceImageInput) GoString added in v1.15.78 

func (s ImportWorkspaceImageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportWorkspaceImageInput) SetApplications added in v1.34.18 

func (s *ImportWorkspaceImageInput) SetApplications(v []*string) *ImportWorkspaceImageInput

SetApplications sets the Applications field's value.

func (*ImportWorkspaceImageInput) SetEc2ImageId added in v1.15.78 

func (s *ImportWorkspaceImageInput) SetEc2ImageId(v string) *ImportWorkspaceImageInput

SetEc2ImageId sets the Ec2ImageId field's value.

func (*ImportWorkspaceImageInput) SetImageDescription added in v1.15.78 

func (s *ImportWorkspaceImageInput) SetImageDescription(v string) *ImportWorkspaceImageInput

SetImageDescription sets the ImageDescription field's value.

func (*ImportWorkspaceImageInput) SetImageName added in v1.15.78 

func (s *ImportWorkspaceImageInput) SetImageName(v string) *ImportWorkspaceImageInput

SetImageName sets the ImageName field's value.

func (*ImportWorkspaceImageInput) SetIngestionProcess added in v1.15.78 

func (s *ImportWorkspaceImageInput) SetIngestionProcess(v string) *ImportWorkspaceImageInput

SetIngestionProcess sets the IngestionProcess field's value.

func (*ImportWorkspaceImageInput) SetTags added in v1.19.5 

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

SetTags sets the Tags field's value.

func (ImportWorkspaceImageInput) String added in v1.15.78 

func (s ImportWorkspaceImageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportWorkspaceImageInput) Validate added in v1.15.78 

func (s *ImportWorkspaceImageInput) Validate() error

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

type ImportWorkspaceImageOutput added in v1.15.78 

type ImportWorkspaceImageOutput struct {

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

func (ImportWorkspaceImageOutput) GoString added in v1.15.78 

func (s ImportWorkspaceImageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportWorkspaceImageOutput) SetImageId added in v1.15.78 

func (s *ImportWorkspaceImageOutput) SetImageId(v string) *ImportWorkspaceImageOutput

SetImageId sets the ImageId field's value.

func (ImportWorkspaceImageOutput) String added in v1.15.78 

func (s ImportWorkspaceImageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IncompatibleApplicationsException added in v1.45.23 

type IncompatibleApplicationsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified application is not compatible with the resource.

func (*IncompatibleApplicationsException) Code added in v1.45.23 

func (s *IncompatibleApplicationsException) Code() string

Code returns the exception type name.

func (*IncompatibleApplicationsException) Error added in v1.45.23 

func (s *IncompatibleApplicationsException) Error() string

func (IncompatibleApplicationsException) GoString added in v1.45.23 

func (s IncompatibleApplicationsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IncompatibleApplicationsException) Message added in v1.45.23 

func (s *IncompatibleApplicationsException) Message() string

Message returns the exception's message.

func (*IncompatibleApplicationsException) OrigErr added in v1.45.23 

func (s *IncompatibleApplicationsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IncompatibleApplicationsException) RequestID added in v1.45.23 

func (s *IncompatibleApplicationsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IncompatibleApplicationsException) StatusCode added in v1.45.23 

func (s *IncompatibleApplicationsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IncompatibleApplicationsException) String added in v1.45.23 

func (s IncompatibleApplicationsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidParameterValuesException added in v1.28.0 

type InvalidParameterValuesException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The exception error message.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

One or more parameter values are not valid.

func (*InvalidParameterValuesException) Code added in v1.28.0 

func (s *InvalidParameterValuesException) Code() string

Code returns the exception type name.

func (*InvalidParameterValuesException) Error added in v1.28.0 

func (s *InvalidParameterValuesException) Error() string

func (InvalidParameterValuesException) GoString added in v1.28.0 

func (s InvalidParameterValuesException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidParameterValuesException) Message added in v1.28.0 

func (s *InvalidParameterValuesException) Message() string

Message returns the exception's message.

func (*InvalidParameterValuesException) OrigErr added in v1.28.0 

func (s *InvalidParameterValuesException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterValuesException) RequestID added in v1.28.0 

func (s *InvalidParameterValuesException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterValuesException) StatusCode added in v1.28.0 

func (s *InvalidParameterValuesException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterValuesException) String added in v1.28.0 

func (s InvalidParameterValuesException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidResourceStateException added in v1.28.0 

type InvalidResourceStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidResourceStateException) Code added in v1.28.0 

func (s *InvalidResourceStateException) Code() string

Code returns the exception type name.

func (*InvalidResourceStateException) Error added in v1.28.0 

func (s *InvalidResourceStateException) Error() string

func (InvalidResourceStateException) GoString added in v1.28.0 

func (s InvalidResourceStateException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidResourceStateException) Message added in v1.28.0 

func (s *InvalidResourceStateException) Message() string

Message returns the exception's message.

func (*InvalidResourceStateException) OrigErr added in v1.28.0 

func (s *InvalidResourceStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidResourceStateException) RequestID added in v1.28.0 

func (s *InvalidResourceStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidResourceStateException) StatusCode added in v1.28.0 

func (s *InvalidResourceStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidResourceStateException) String added in v1.28.0 

func (s InvalidResourceStateException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IosClientBrandingAttributes added in v1.43.30 

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 `min:"1" type:"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 `type:"map"`

	// 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 (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/)
	// in the Apple Human Interface Guidelines.
	Logo2xUrl *string `min:"1" type:"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 (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/)
	// in the Apple Human Interface Guidelines.
	Logo3xUrl *string `min:"1" type:"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 `min:"1" type:"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 `min:"6" type:"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 `min:"1" type:"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.

func (IosClientBrandingAttributes) GoString added in v1.43.30 

func (s IosClientBrandingAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive". 

func (s *IosClientBrandingAttributes) SetForgotPasswordLink(v string) *IosClientBrandingAttributes

SetForgotPasswordLink sets the ForgotPasswordLink field's value.

func (*IosClientBrandingAttributes) SetLoginMessage added in v1.43.30 

func (s *IosClientBrandingAttributes) SetLoginMessage(v map[string]*string) *IosClientBrandingAttributes

SetLoginMessage sets the LoginMessage field's value.

func (*IosClientBrandingAttributes) SetLogo2xUrl added in v1.43.30 

func (s *IosClientBrandingAttributes) SetLogo2xUrl(v string) *IosClientBrandingAttributes

SetLogo2xUrl sets the Logo2xUrl field's value.

func (*IosClientBrandingAttributes) SetLogo3xUrl added in v1.43.30 

func (s *IosClientBrandingAttributes) SetLogo3xUrl(v string) *IosClientBrandingAttributes

SetLogo3xUrl sets the Logo3xUrl field's value.

func (*IosClientBrandingAttributes) SetLogoUrl added in v1.43.30 

func (s *IosClientBrandingAttributes) SetLogoUrl(v string) *IosClientBrandingAttributes

SetLogoUrl sets the LogoUrl field's value.

func (*IosClientBrandingAttributes) SetSupportEmail added in v1.43.30 

func (s *IosClientBrandingAttributes) SetSupportEmail(v string) *IosClientBrandingAttributes

SetSupportEmail sets the SupportEmail field's value. 

func (s *IosClientBrandingAttributes) SetSupportLink(v string) *IosClientBrandingAttributes

SetSupportLink sets the SupportLink field's value.

func (IosClientBrandingAttributes) String added in v1.43.30 

func (s IosClientBrandingAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IosImportClientBrandingAttributes added in v1.43.30 

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 `min:"1" type:"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 `type:"map"`

	// (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 is automatically base64 encoded/decoded by the SDK.
	Logo []byte `min:"1" type:"blob"`

	// 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 (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/)
	// in the Apple Human Interface Guidelines.
	// Logo2x is automatically base64 encoded/decoded by the SDK.
	Logo2x []byte `min:"1" type:"blob"`

	// 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 (https://developer.apple.com/design/human-interface-guidelines/ios/icons-and-images/image-size-and-resolution/)
	// in the Apple Human Interface Guidelines.
	// Logo3x is automatically base64 encoded/decoded by the SDK.
	Logo3x []byte `min:"1" type:"blob"`

	// 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 `min:"6" type:"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 `min:"1" type:"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.

func (IosImportClientBrandingAttributes) GoString added in v1.43.30 

func (s IosImportClientBrandingAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive". 

func (s *IosImportClientBrandingAttributes) SetForgotPasswordLink(v string) *IosImportClientBrandingAttributes

SetForgotPasswordLink sets the ForgotPasswordLink field's value.

func (*IosImportClientBrandingAttributes) SetLoginMessage added in v1.43.30 

func (s *IosImportClientBrandingAttributes) SetLoginMessage(v map[string]*string) *IosImportClientBrandingAttributes

SetLoginMessage sets the LoginMessage field's value. 

func (s *IosImportClientBrandingAttributes) SetLogo(v []byte) *IosImportClientBrandingAttributes

SetLogo sets the Logo field's value.

func (*IosImportClientBrandingAttributes) SetLogo2x added in v1.43.30 

func (s *IosImportClientBrandingAttributes) SetLogo2x(v []byte) *IosImportClientBrandingAttributes

SetLogo2x sets the Logo2x field's value.

func (*IosImportClientBrandingAttributes) SetLogo3x added in v1.43.30 

func (s *IosImportClientBrandingAttributes) SetLogo3x(v []byte) *IosImportClientBrandingAttributes

SetLogo3x sets the Logo3x field's value.

func (*IosImportClientBrandingAttributes) SetSupportEmail added in v1.43.30 

func (s *IosImportClientBrandingAttributes) SetSupportEmail(v string) *IosImportClientBrandingAttributes

SetSupportEmail sets the SupportEmail field's value. 

func (s *IosImportClientBrandingAttributes) SetSupportLink(v string) *IosImportClientBrandingAttributes

SetSupportLink sets the SupportLink field's value.

func (IosImportClientBrandingAttributes) String added in v1.43.30 

func (s IosImportClientBrandingAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IosImportClientBrandingAttributes) Validate added in v1.43.30 

func (s *IosImportClientBrandingAttributes) Validate() error

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

type IpGroup added in v1.13.39 

type IpGroup struct {

	// The description of the group.
	GroupDesc *string `locationName:"groupDesc" type:"string"`

	// The identifier of the group.
	GroupId *string `locationName:"groupId" type:"string"`

	// The name of the group.
	GroupName *string `locationName:"groupName" type:"string"`

	// The rules.
	UserRules []*IpRuleItem `locationName:"userRules" type:"list"`
	// contains filtered or unexported fields
}

Describes an IP access control group.

func (IpGroup) GoString added in v1.13.39 

func (s IpGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IpGroup) SetGroupDesc added in v1.13.39 

func (s *IpGroup) SetGroupDesc(v string) *IpGroup

SetGroupDesc sets the GroupDesc field's value.

func (*IpGroup) SetGroupId added in v1.13.39 

func (s *IpGroup) SetGroupId(v string) *IpGroup

SetGroupId sets the GroupId field's value.

func (*IpGroup) SetGroupName added in v1.13.39 

func (s *IpGroup) SetGroupName(v string) *IpGroup

SetGroupName sets the GroupName field's value.

func (*IpGroup) SetUserRules added in v1.13.39 

func (s *IpGroup) SetUserRules(v []*IpRuleItem) *IpGroup

SetUserRules sets the UserRules field's value.

func (IpGroup) String added in v1.13.39 

func (s IpGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IpRuleItem added in v1.13.39 

type IpRuleItem struct {

	// The IP address range, in CIDR notation.
	IpRule *string `locationName:"ipRule" type:"string"`

	// The description.
	RuleDesc *string `locationName:"ruleDesc" type:"string"`
	// contains filtered or unexported fields
}

Describes a rule for an IP access control group.

func (IpRuleItem) GoString added in v1.13.39 

func (s IpRuleItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IpRuleItem) SetIpRule added in v1.13.39 

func (s *IpRuleItem) SetIpRule(v string) *IpRuleItem

SetIpRule sets the IpRule field's value.

func (*IpRuleItem) SetRuleDesc added in v1.13.39 

func (s *IpRuleItem) SetRuleDesc(v string) *IpRuleItem

SetRuleDesc sets the RuleDesc field's value.

func (IpRuleItem) String added in v1.13.39 

func (s IpRuleItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAvailableManagementCidrRangesInput added in v1.15.78 

type ListAvailableManagementCidrRangesInput struct {

	// The IP address range to search. Specify an IP address range that is compatible
	// with your network and in CIDR notation (that is, specify the range as an
	// IPv4 CIDR block).
	//
	// ManagementCidrRangeConstraint is a required field
	ManagementCidrRangeConstraint *string `type:"string" required:"true"`

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

	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAvailableManagementCidrRangesInput) GoString added in v1.15.78 

func (s ListAvailableManagementCidrRangesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAvailableManagementCidrRangesInput) SetManagementCidrRangeConstraint added in v1.15.78 

func (s *ListAvailableManagementCidrRangesInput) SetManagementCidrRangeConstraint(v string) *ListAvailableManagementCidrRangesInput

SetManagementCidrRangeConstraint sets the ManagementCidrRangeConstraint field's value.

func (*ListAvailableManagementCidrRangesInput) SetMaxResults added in v1.15.78 

func (s *ListAvailableManagementCidrRangesInput) SetMaxResults(v int64) *ListAvailableManagementCidrRangesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAvailableManagementCidrRangesInput) SetNextToken added in v1.15.78 

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

SetNextToken sets the NextToken field's value.

func (ListAvailableManagementCidrRangesInput) String added in v1.15.78 

func (s ListAvailableManagementCidrRangesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAvailableManagementCidrRangesInput) Validate added in v1.15.78 

func (s *ListAvailableManagementCidrRangesInput) Validate() error

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

type ListAvailableManagementCidrRangesOutput added in v1.15.78 

type ListAvailableManagementCidrRangesOutput struct {

	// The list of available IP address ranges, specified as IPv4 CIDR blocks.
	ManagementCidrRanges []*string `type:"list"`

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAvailableManagementCidrRangesOutput) GoString added in v1.15.78 

func (s ListAvailableManagementCidrRangesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAvailableManagementCidrRangesOutput) SetManagementCidrRanges added in v1.15.78 

func (s *ListAvailableManagementCidrRangesOutput) SetManagementCidrRanges(v []*string) *ListAvailableManagementCidrRangesOutput

SetManagementCidrRanges sets the ManagementCidrRanges field's value.

func (*ListAvailableManagementCidrRangesOutput) SetNextToken added in v1.15.78 

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

SetNextToken sets the NextToken field's value.

func (ListAvailableManagementCidrRangesOutput) String added in v1.15.78 

func (s ListAvailableManagementCidrRangesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MigrateWorkspaceInput added in v1.28.0 

type MigrateWorkspaceInput struct {

	// The identifier of the target bundle type to migrate the WorkSpace to.
	//
	// BundleId is a required field
	BundleId *string `type:"string" required:"true"`

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

func (MigrateWorkspaceInput) GoString added in v1.28.0 

func (s MigrateWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MigrateWorkspaceInput) SetBundleId added in v1.28.0 

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

SetBundleId sets the BundleId field's value.

func (*MigrateWorkspaceInput) SetSourceWorkspaceId added in v1.28.0 

func (s *MigrateWorkspaceInput) SetSourceWorkspaceId(v string) *MigrateWorkspaceInput

SetSourceWorkspaceId sets the SourceWorkspaceId field's value.

func (MigrateWorkspaceInput) String added in v1.28.0 

func (s MigrateWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MigrateWorkspaceInput) Validate added in v1.28.0 

func (s *MigrateWorkspaceInput) Validate() error

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

type MigrateWorkspaceOutput added in v1.28.0 

type MigrateWorkspaceOutput struct {

	// The original identifier of the WorkSpace that is being migrated.
	SourceWorkspaceId *string `type:"string"`

	// The new identifier of the WorkSpace that is being migrated. If the migration
	// does not succeed, the target WorkSpace ID will not be used, and the WorkSpace
	// will still have the original WorkSpace ID.
	TargetWorkspaceId *string `type:"string"`
	// contains filtered or unexported fields
}

func (MigrateWorkspaceOutput) GoString added in v1.28.0 

func (s MigrateWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MigrateWorkspaceOutput) SetSourceWorkspaceId added in v1.28.0 

func (s *MigrateWorkspaceOutput) SetSourceWorkspaceId(v string) *MigrateWorkspaceOutput

SetSourceWorkspaceId sets the SourceWorkspaceId field's value.

func (*MigrateWorkspaceOutput) SetTargetWorkspaceId added in v1.28.0 

func (s *MigrateWorkspaceOutput) SetTargetWorkspaceId(v string) *MigrateWorkspaceOutput

SetTargetWorkspaceId sets the TargetWorkspaceId field's value.

func (MigrateWorkspaceOutput) String added in v1.28.0 

func (s MigrateWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModificationState added in v1.12.54 

type ModificationState struct {

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

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

Describes a WorkSpace modification.

func (ModificationState) GoString added in v1.12.54 

func (s ModificationState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModificationState) SetResource added in v1.12.54 

func (s *ModificationState) SetResource(v string) *ModificationState

SetResource sets the Resource field's value.

func (*ModificationState) SetState added in v1.12.54 

func (s *ModificationState) SetState(v string) *ModificationState

SetState sets the State field's value.

func (ModificationState) String added in v1.12.54 

func (s ModificationState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyAccountInput added in v1.15.78 

type ModifyAccountInput struct {

	// The IP address range, specified as an IPv4 CIDR block, for the management
	// network interface. Specify an IP address range that is compatible with your
	// network and in CIDR notation (that is, specify the range as an IPv4 CIDR
	// block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It
	// must also be specified as available by the ListAvailableManagementCidrRanges
	// operation.
	DedicatedTenancyManagementCidrRange *string `type:"string"`

	// The status of BYOL.
	DedicatedTenancySupport *string `type:"string" enum:"DedicatedTenancySupportEnum"`
	// contains filtered or unexported fields
}

func (ModifyAccountInput) GoString added in v1.15.78 

func (s ModifyAccountInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyAccountInput) SetDedicatedTenancyManagementCidrRange added in v1.15.78 

func (s *ModifyAccountInput) SetDedicatedTenancyManagementCidrRange(v string) *ModifyAccountInput

SetDedicatedTenancyManagementCidrRange sets the DedicatedTenancyManagementCidrRange field's value.

func (*ModifyAccountInput) SetDedicatedTenancySupport added in v1.15.78 

func (s *ModifyAccountInput) SetDedicatedTenancySupport(v string) *ModifyAccountInput

SetDedicatedTenancySupport sets the DedicatedTenancySupport field's value.

func (ModifyAccountInput) String added in v1.15.78 

func (s ModifyAccountInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyAccountOutput added in v1.15.78 

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

func (ModifyAccountOutput) GoString added in v1.15.78 

func (s ModifyAccountOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifyAccountOutput) String added in v1.15.78 

func (s ModifyAccountOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyCertificateBasedAuthPropertiesInput added in v1.44.138 

type ModifyCertificateBasedAuthPropertiesInput struct {

	// The properties of the certificate-based authentication.
	CertificateBasedAuthProperties *CertificateBasedAuthProperties `type:"structure"`

	// The properties of the certificate-based authentication you want to delete.
	PropertiesToDelete []*string `type:"list" enum:"DeletableCertificateBasedAuthProperty"`

	// The resource identifiers, in the form of directory IDs.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyCertificateBasedAuthPropertiesInput) GoString added in v1.44.138 

func (s ModifyCertificateBasedAuthPropertiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCertificateBasedAuthPropertiesInput) SetCertificateBasedAuthProperties added in v1.44.138 

func (s *ModifyCertificateBasedAuthPropertiesInput) SetCertificateBasedAuthProperties(v *CertificateBasedAuthProperties) *ModifyCertificateBasedAuthPropertiesInput

SetCertificateBasedAuthProperties sets the CertificateBasedAuthProperties field's value.

func (*ModifyCertificateBasedAuthPropertiesInput) SetPropertiesToDelete added in v1.44.138 

func (s *ModifyCertificateBasedAuthPropertiesInput) SetPropertiesToDelete(v []*string) *ModifyCertificateBasedAuthPropertiesInput

SetPropertiesToDelete sets the PropertiesToDelete field's value.

func (*ModifyCertificateBasedAuthPropertiesInput) SetResourceId added in v1.44.138 

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

SetResourceId sets the ResourceId field's value.

func (ModifyCertificateBasedAuthPropertiesInput) String added in v1.44.138 

func (s ModifyCertificateBasedAuthPropertiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyCertificateBasedAuthPropertiesInput) Validate added in v1.44.138 

func (s *ModifyCertificateBasedAuthPropertiesInput) Validate() error

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

type ModifyCertificateBasedAuthPropertiesOutput added in v1.44.138 

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

func (ModifyCertificateBasedAuthPropertiesOutput) GoString added in v1.44.138 

func (s ModifyCertificateBasedAuthPropertiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifyCertificateBasedAuthPropertiesOutput) String added in v1.44.138 

func (s ModifyCertificateBasedAuthPropertiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyClientPropertiesInput added in v1.15.79 

type ModifyClientPropertiesInput struct {

	// Information about the Amazon WorkSpaces client.
	//
	// ClientProperties is a required field
	ClientProperties *ClientProperties `type:"structure" required:"true"`

	// The resource identifiers, in the form of directory IDs.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyClientPropertiesInput) GoString added in v1.15.79 

func (s ModifyClientPropertiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyClientPropertiesInput) SetClientProperties added in v1.15.79 

func (s *ModifyClientPropertiesInput) SetClientProperties(v *ClientProperties) *ModifyClientPropertiesInput

SetClientProperties sets the ClientProperties field's value.

func (*ModifyClientPropertiesInput) SetResourceId added in v1.15.79 

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

SetResourceId sets the ResourceId field's value.

func (ModifyClientPropertiesInput) String added in v1.15.79 

func (s ModifyClientPropertiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyClientPropertiesInput) Validate added in v1.15.79 

func (s *ModifyClientPropertiesInput) Validate() error

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

type ModifyClientPropertiesOutput added in v1.15.79 

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

func (ModifyClientPropertiesOutput) GoString added in v1.15.79 

func (s ModifyClientPropertiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifyClientPropertiesOutput) String added in v1.15.79 

func (s ModifyClientPropertiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifySamlPropertiesInput added in v1.44.67 

type ModifySamlPropertiesInput struct {

	// The SAML properties to delete as part of your request.
	//
	// Specify one of the following options:
	//
	//    * SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.
	//
	//    * SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state
	//    parameter name.
	PropertiesToDelete []*string `type:"list" enum:"DeletableSamlProperty"`

	// The directory identifier for which you want to configure SAML properties.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`

	// The properties for configuring SAML 2.0 authentication.
	SamlProperties *SamlProperties `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifySamlPropertiesInput) GoString added in v1.44.67 

func (s ModifySamlPropertiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifySamlPropertiesInput) SetPropertiesToDelete added in v1.44.67 

func (s *ModifySamlPropertiesInput) SetPropertiesToDelete(v []*string) *ModifySamlPropertiesInput

SetPropertiesToDelete sets the PropertiesToDelete field's value.

func (*ModifySamlPropertiesInput) SetResourceId added in v1.44.67 

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

SetResourceId sets the ResourceId field's value.

func (*ModifySamlPropertiesInput) SetSamlProperties added in v1.44.67 

func (s *ModifySamlPropertiesInput) SetSamlProperties(v *SamlProperties) *ModifySamlPropertiesInput

SetSamlProperties sets the SamlProperties field's value.

func (ModifySamlPropertiesInput) String added in v1.44.67 

func (s ModifySamlPropertiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifySamlPropertiesInput) Validate added in v1.44.67 

func (s *ModifySamlPropertiesInput) Validate() error

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

type ModifySamlPropertiesOutput added in v1.44.67 

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

func (ModifySamlPropertiesOutput) GoString added in v1.44.67 

func (s ModifySamlPropertiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifySamlPropertiesOutput) String added in v1.44.67 

func (s ModifySamlPropertiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifySelfservicePermissionsInput added in v1.25.36 

type ModifySelfservicePermissionsInput struct {

	// The identifier of the directory.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`

	// The permissions to enable or disable self-service capabilities.
	//
	// SelfservicePermissions is a required field
	SelfservicePermissions *SelfservicePermissions `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ModifySelfservicePermissionsInput) GoString added in v1.25.36 

func (s ModifySelfservicePermissionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifySelfservicePermissionsInput) SetResourceId added in v1.25.36 

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

SetResourceId sets the ResourceId field's value.

func (*ModifySelfservicePermissionsInput) SetSelfservicePermissions added in v1.25.36 

func (s *ModifySelfservicePermissionsInput) SetSelfservicePermissions(v *SelfservicePermissions) *ModifySelfservicePermissionsInput

SetSelfservicePermissions sets the SelfservicePermissions field's value.

func (ModifySelfservicePermissionsInput) String added in v1.25.36 

func (s ModifySelfservicePermissionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifySelfservicePermissionsInput) Validate added in v1.25.36 

func (s *ModifySelfservicePermissionsInput) Validate() error

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

type ModifySelfservicePermissionsOutput added in v1.25.36 

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

func (ModifySelfservicePermissionsOutput) GoString added in v1.25.36 

func (s ModifySelfservicePermissionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifySelfservicePermissionsOutput) String added in v1.25.36 

func (s ModifySelfservicePermissionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyWorkspaceAccessPropertiesInput added in v1.25.36 

type ModifyWorkspaceAccessPropertiesInput struct {

	// The identifier of the directory.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`

	// The device types and operating systems to enable or disable for access.
	//
	// WorkspaceAccessProperties is a required field
	WorkspaceAccessProperties *WorkspaceAccessProperties `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyWorkspaceAccessPropertiesInput) GoString added in v1.25.36 

func (s ModifyWorkspaceAccessPropertiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyWorkspaceAccessPropertiesInput) SetResourceId added in v1.25.36 

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

SetResourceId sets the ResourceId field's value.

func (*ModifyWorkspaceAccessPropertiesInput) SetWorkspaceAccessProperties added in v1.25.36 

func (s *ModifyWorkspaceAccessPropertiesInput) SetWorkspaceAccessProperties(v *WorkspaceAccessProperties) *ModifyWorkspaceAccessPropertiesInput

SetWorkspaceAccessProperties sets the WorkspaceAccessProperties field's value.

func (ModifyWorkspaceAccessPropertiesInput) String added in v1.25.36 

func (s ModifyWorkspaceAccessPropertiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyWorkspaceAccessPropertiesInput) Validate added in v1.25.36 

func (s *ModifyWorkspaceAccessPropertiesInput) Validate() error

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

type ModifyWorkspaceAccessPropertiesOutput added in v1.25.36 

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

func (ModifyWorkspaceAccessPropertiesOutput) GoString added in v1.25.36 

func (s ModifyWorkspaceAccessPropertiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifyWorkspaceAccessPropertiesOutput) String added in v1.25.36 

func (s ModifyWorkspaceAccessPropertiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyWorkspaceCreationPropertiesInput added in v1.25.36 

type ModifyWorkspaceCreationPropertiesInput struct {

	// The identifier of the directory.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`

	// The default properties for creating WorkSpaces.
	//
	// WorkspaceCreationProperties is a required field
	WorkspaceCreationProperties *WorkspaceCreationProperties `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyWorkspaceCreationPropertiesInput) GoString added in v1.25.36 

func (s ModifyWorkspaceCreationPropertiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyWorkspaceCreationPropertiesInput) SetResourceId added in v1.25.36 

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

SetResourceId sets the ResourceId field's value.

func (*ModifyWorkspaceCreationPropertiesInput) SetWorkspaceCreationProperties added in v1.25.36 

func (s *ModifyWorkspaceCreationPropertiesInput) SetWorkspaceCreationProperties(v *WorkspaceCreationProperties) *ModifyWorkspaceCreationPropertiesInput

SetWorkspaceCreationProperties sets the WorkspaceCreationProperties field's value.

func (ModifyWorkspaceCreationPropertiesInput) String added in v1.25.36 

func (s ModifyWorkspaceCreationPropertiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyWorkspaceCreationPropertiesInput) Validate added in v1.25.36 

func (s *ModifyWorkspaceCreationPropertiesInput) Validate() error

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

type ModifyWorkspaceCreationPropertiesOutput added in v1.25.36 

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

func (ModifyWorkspaceCreationPropertiesOutput) GoString added in v1.25.36 

func (s ModifyWorkspaceCreationPropertiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifyWorkspaceCreationPropertiesOutput) String added in v1.25.36 

func (s ModifyWorkspaceCreationPropertiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyWorkspacePropertiesInput added in v1.4.3 

type ModifyWorkspacePropertiesInput struct {

	// Indicates the data replication status.
	DataReplication *string `type:"string" enum:"DataReplication"`

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

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

func (ModifyWorkspacePropertiesInput) GoString added in v1.4.3 

func (s ModifyWorkspacePropertiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyWorkspacePropertiesInput) SetDataReplication added in v1.48.4 

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

SetDataReplication sets the DataReplication field's value.

func (*ModifyWorkspacePropertiesInput) SetWorkspaceId added in v1.5.0 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (*ModifyWorkspacePropertiesInput) SetWorkspaceProperties added in v1.5.0 

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

SetWorkspaceProperties sets the WorkspaceProperties field's value.

func (ModifyWorkspacePropertiesInput) String added in v1.4.3 

func (s ModifyWorkspacePropertiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyWorkspacePropertiesInput) Validate added in v1.4.3 

func (s *ModifyWorkspacePropertiesInput) Validate() error

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

type ModifyWorkspacePropertiesOutput added in v1.4.3 

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

func (ModifyWorkspacePropertiesOutput) GoString added in v1.4.3 

func (s ModifyWorkspacePropertiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifyWorkspacePropertiesOutput) String added in v1.4.3 

func (s ModifyWorkspacePropertiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ModifyWorkspaceStateInput added in v1.13.39 

type ModifyWorkspaceStateInput struct {

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

	// The WorkSpace state.
	//
	// WorkspaceState is a required field
	WorkspaceState *string `type:"string" required:"true" enum:"TargetWorkspaceState"`
	// contains filtered or unexported fields
}

func (ModifyWorkspaceStateInput) GoString added in v1.13.39 

func (s ModifyWorkspaceStateInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyWorkspaceStateInput) SetWorkspaceId added in v1.13.39 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (*ModifyWorkspaceStateInput) SetWorkspaceState added in v1.13.39 

func (s *ModifyWorkspaceStateInput) SetWorkspaceState(v string) *ModifyWorkspaceStateInput

SetWorkspaceState sets the WorkspaceState field's value.

func (ModifyWorkspaceStateInput) String added in v1.13.39 

func (s ModifyWorkspaceStateInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ModifyWorkspaceStateInput) Validate added in v1.13.39 

func (s *ModifyWorkspaceStateInput) Validate() error

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

type ModifyWorkspaceStateOutput added in v1.13.39 

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

func (ModifyWorkspaceStateOutput) GoString added in v1.13.39 

func (s ModifyWorkspaceStateOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ModifyWorkspaceStateOutput) String added in v1.13.39 

func (s ModifyWorkspaceStateOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OperatingSystem added in v1.15.78 

type OperatingSystem struct {

	// The operating system.
	Type *string `type:"string" enum:"OperatingSystemType"`
	// contains filtered or unexported fields
}

The operating system that the image is running.

func (OperatingSystem) GoString added in v1.15.78 

func (s OperatingSystem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OperatingSystem) SetType added in v1.15.78 

func (s *OperatingSystem) SetType(v string) *OperatingSystem

SetType sets the Type field's value.

func (OperatingSystem) String added in v1.15.78 

func (s OperatingSystem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OperatingSystemNotCompatibleException added in v1.45.23 

type OperatingSystemNotCompatibleException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*OperatingSystemNotCompatibleException) Code added in v1.45.23 

func (s *OperatingSystemNotCompatibleException) Code() string

Code returns the exception type name.

func (*OperatingSystemNotCompatibleException) Error added in v1.45.23 

func (s *OperatingSystemNotCompatibleException) Error() string

func (OperatingSystemNotCompatibleException) GoString added in v1.45.23 

func (s OperatingSystemNotCompatibleException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OperatingSystemNotCompatibleException) Message added in v1.45.23 

func (s *OperatingSystemNotCompatibleException) Message() string

Message returns the exception's message.

func (*OperatingSystemNotCompatibleException) OrigErr added in v1.45.23 

func (s *OperatingSystemNotCompatibleException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OperatingSystemNotCompatibleException) RequestID added in v1.45.23 

func (s *OperatingSystemNotCompatibleException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OperatingSystemNotCompatibleException) StatusCode added in v1.45.23 

func (s *OperatingSystemNotCompatibleException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OperatingSystemNotCompatibleException) String added in v1.45.23 

func (s OperatingSystemNotCompatibleException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OperationInProgressException added in v1.28.0 

type OperationInProgressException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*OperationInProgressException) Code added in v1.28.0 

func (s *OperationInProgressException) Code() string

Code returns the exception type name.

func (*OperationInProgressException) Error added in v1.28.0 

func (s *OperationInProgressException) Error() string

func (OperationInProgressException) GoString added in v1.28.0 

func (s OperationInProgressException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OperationInProgressException) Message added in v1.28.0 

func (s *OperationInProgressException) Message() string

Message returns the exception's message.

func (*OperationInProgressException) OrigErr added in v1.28.0 

func (s *OperationInProgressException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OperationInProgressException) RequestID added in v1.28.0 

func (s *OperationInProgressException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OperationInProgressException) StatusCode added in v1.28.0 

func (s *OperationInProgressException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OperationInProgressException) String added in v1.28.0 

func (s OperationInProgressException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type OperationNotSupportedException added in v1.28.0 

type OperationNotSupportedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The exception error message.
	Message_ *string `locationName:"message" type:"string"`

	// The exception error reason.
	Reason *string `locationName:"reason" type:"string"`
	// contains filtered or unexported fields
}

This operation is not supported.

func (*OperationNotSupportedException) Code added in v1.28.0 

func (s *OperationNotSupportedException) Code() string

Code returns the exception type name.

func (*OperationNotSupportedException) Error added in v1.28.0 

func (s *OperationNotSupportedException) Error() string

func (OperationNotSupportedException) GoString added in v1.28.0 

func (s OperationNotSupportedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OperationNotSupportedException) Message added in v1.28.0 

func (s *OperationNotSupportedException) Message() string

Message returns the exception's message.

func (*OperationNotSupportedException) OrigErr added in v1.28.0 

func (s *OperationNotSupportedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OperationNotSupportedException) RequestID added in v1.28.0 

func (s *OperationNotSupportedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OperationNotSupportedException) StatusCode added in v1.28.0 

func (s *OperationNotSupportedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OperationNotSupportedException) String added in v1.28.0 

func (s OperationNotSupportedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PendingCreateStandbyWorkspacesRequest added in v1.44.140 

type PendingCreateStandbyWorkspacesRequest struct {

	// The identifier of the directory for the standby WorkSpace.
	DirectoryId *string `min:"10" type:"string"`

	// The operational state of the standby WorkSpace.
	State *string `type:"string" enum:"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
	// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html)
	// before the WorkSpace is created, the information returned can be incomplete.
	UserName *string `min:"1" type:"string"`

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

Information about the standby WorkSpace.

func (PendingCreateStandbyWorkspacesRequest) GoString added in v1.44.140 

func (s PendingCreateStandbyWorkspacesRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PendingCreateStandbyWorkspacesRequest) SetDirectoryId added in v1.44.140 

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

SetDirectoryId sets the DirectoryId field's value.

func (*PendingCreateStandbyWorkspacesRequest) SetState added in v1.44.140 

func (s *PendingCreateStandbyWorkspacesRequest) SetState(v string) *PendingCreateStandbyWorkspacesRequest

SetState sets the State field's value.

func (*PendingCreateStandbyWorkspacesRequest) SetUserName added in v1.44.140 

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

SetUserName sets the UserName field's value.

func (*PendingCreateStandbyWorkspacesRequest) SetWorkspaceId added in v1.44.140 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (PendingCreateStandbyWorkspacesRequest) String added in v1.44.140 

func (s PendingCreateStandbyWorkspacesRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RebootRequest 

type RebootRequest struct {

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

Describes the information used to reboot a WorkSpace.

func (RebootRequest) GoString added in v0.6.5 

func (s RebootRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootRequest) SetWorkspaceId added in v1.5.0 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (RebootRequest) String added in v0.6.5 

func (s RebootRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootRequest) Validate added in v1.1.21 

func (s *RebootRequest) Validate() error

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

type RebootWorkspacesInput 

type RebootWorkspacesInput struct {

	// The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
	//
	// RebootWorkspaceRequests is a required field
	RebootWorkspaceRequests []*RebootRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RebootWorkspacesInput) GoString added in v0.6.5 

func (s RebootWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootWorkspacesInput) SetRebootWorkspaceRequests added in v1.5.0 

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

SetRebootWorkspaceRequests sets the RebootWorkspaceRequests field's value.

func (RebootWorkspacesInput) String added in v0.6.5 

func (s RebootWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootWorkspacesInput) Validate added in v1.1.21 

func (s *RebootWorkspacesInput) Validate() error

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

type RebootWorkspacesOutput 

type RebootWorkspacesOutput struct {

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

func (RebootWorkspacesOutput) GoString added in v0.6.5 

func (s RebootWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebootWorkspacesOutput) SetFailedRequests added in v1.5.0 

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

SetFailedRequests sets the FailedRequests field's value.

func (RebootWorkspacesOutput) String added in v0.6.5 

func (s RebootWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RebuildRequest 

type RebuildRequest struct {

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

Describes the information used to rebuild a WorkSpace.

func (RebuildRequest) GoString added in v0.6.5 

func (s RebuildRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebuildRequest) SetWorkspaceId added in v1.5.0 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (RebuildRequest) String added in v0.6.5 

func (s RebuildRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebuildRequest) Validate added in v1.1.21 

func (s *RebuildRequest) Validate() error

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

type RebuildWorkspacesInput 

type RebuildWorkspacesInput struct {

	// The WorkSpace to rebuild. You can specify a single WorkSpace.
	//
	// RebuildWorkspaceRequests is a required field
	RebuildWorkspaceRequests []*RebuildRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RebuildWorkspacesInput) GoString added in v0.6.5 

func (s RebuildWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebuildWorkspacesInput) SetRebuildWorkspaceRequests added in v1.5.0 

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

SetRebuildWorkspaceRequests sets the RebuildWorkspaceRequests field's value.

func (RebuildWorkspacesInput) String added in v0.6.5 

func (s RebuildWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebuildWorkspacesInput) Validate added in v1.1.21 

func (s *RebuildWorkspacesInput) Validate() error

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

type RebuildWorkspacesOutput 

type RebuildWorkspacesOutput struct {

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

func (RebuildWorkspacesOutput) GoString added in v0.6.5 

func (s RebuildWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RebuildWorkspacesOutput) SetFailedRequests added in v1.5.0 

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

SetFailedRequests sets the FailedRequests field's value.

func (RebuildWorkspacesOutput) String added in v0.6.5 

func (s RebuildWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RegisterWorkspaceDirectoryInput added in v1.25.36 

type RegisterWorkspaceDirectoryInput struct {

	// The identifier of the directory. You cannot register a directory if it does
	// not have a status of Active. If the directory does not have a status of Active,
	// you will receive an InvalidResourceStateException error. If you have already
	// registered the maximum number of directories that you can register with Amazon
	// WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister
	// directories that you are not using for WorkSpaces, and try again.
	//
	// DirectoryId is a required field
	DirectoryId *string `min:"10" type:"string" required:"true"`

	// Indicates whether self-service capabilities are enabled or disabled.
	EnableSelfService *bool `type:"boolean"`

	// Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled
	// this parameter and WorkDocs is not available in the Region, you will receive
	// an OperationNotSupportedException error. Set EnableWorkDocs to disabled,
	// and try again.
	//
	// EnableWorkDocs is a required field
	EnableWorkDocs *bool `type:"boolean" required:"true"`

	// The identifiers of the subnets for your virtual private cloud (VPC). Make
	// sure that the subnets are in supported Availability Zones. The subnets must
	// also be in separate Availability Zones. If these conditions are not met,
	// you will receive an OperationNotSupportedException error.
	SubnetIds []*string `type:"list"`

	// The tags associated with the directory.
	Tags []*Tag `type:"list"`

	// Indicates whether your WorkSpace directory is dedicated or shared. To use
	// Bring Your Own License (BYOL) images, this value must be set to DEDICATED
	// and your Amazon Web Services account must be enabled for BYOL. If your account
	// has not been enabled for BYOL, you will receive an InvalidParameterValuesException
	// error. For more information about BYOL images, see Bring Your Own Windows
	// Desktop Images (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html).
	Tenancy *string `type:"string" enum:"Tenancy"`
	// contains filtered or unexported fields
}

func (RegisterWorkspaceDirectoryInput) GoString added in v1.25.36 

func (s RegisterWorkspaceDirectoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterWorkspaceDirectoryInput) SetDirectoryId added in v1.25.36 

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

SetDirectoryId sets the DirectoryId field's value.

func (*RegisterWorkspaceDirectoryInput) SetEnableSelfService added in v1.25.36 

func (s *RegisterWorkspaceDirectoryInput) SetEnableSelfService(v bool) *RegisterWorkspaceDirectoryInput

SetEnableSelfService sets the EnableSelfService field's value.

func (*RegisterWorkspaceDirectoryInput) SetEnableWorkDocs added in v1.25.36 

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

SetEnableWorkDocs sets the EnableWorkDocs field's value.

func (*RegisterWorkspaceDirectoryInput) SetSubnetIds added in v1.25.36 

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

SetSubnetIds sets the SubnetIds field's value.

func (*RegisterWorkspaceDirectoryInput) SetTags added in v1.25.36 

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

SetTags sets the Tags field's value.

func (*RegisterWorkspaceDirectoryInput) SetTenancy added in v1.25.36 

func (s *RegisterWorkspaceDirectoryInput) SetTenancy(v string) *RegisterWorkspaceDirectoryInput

SetTenancy sets the Tenancy field's value.

func (RegisterWorkspaceDirectoryInput) String added in v1.25.36 

func (s RegisterWorkspaceDirectoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RegisterWorkspaceDirectoryInput) Validate added in v1.25.36 

func (s *RegisterWorkspaceDirectoryInput) Validate() error

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

type RegisterWorkspaceDirectoryOutput added in v1.25.36 

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

func (RegisterWorkspaceDirectoryOutput) GoString added in v1.25.36 

func (s RegisterWorkspaceDirectoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RegisterWorkspaceDirectoryOutput) String added in v1.25.36 

func (s RegisterWorkspaceDirectoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RelatedWorkspaceProperties added in v1.44.140 

type RelatedWorkspaceProperties struct {

	// The Region of the related WorkSpace.
	Region *string `min:"1" type:"string"`

	// Indicates the state of the WorkSpace.
	State *string `type:"string" enum:"WorkspaceState"`

	// Indicates the type of WorkSpace.
	Type *string `type:"string" enum:"StandbyWorkspaceRelationshipType"`

	// The identifier of the related WorkSpace.
	WorkspaceId *string `type:"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.

func (RelatedWorkspaceProperties) GoString added in v1.44.140 

func (s RelatedWorkspaceProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RelatedWorkspaceProperties) SetRegion added in v1.44.140 

func (s *RelatedWorkspaceProperties) SetRegion(v string) *RelatedWorkspaceProperties

SetRegion sets the Region field's value.

func (*RelatedWorkspaceProperties) SetState added in v1.44.140 

func (s *RelatedWorkspaceProperties) SetState(v string) *RelatedWorkspaceProperties

SetState sets the State field's value.

func (*RelatedWorkspaceProperties) SetType added in v1.44.140 

func (s *RelatedWorkspaceProperties) SetType(v string) *RelatedWorkspaceProperties

SetType sets the Type field's value.

func (*RelatedWorkspaceProperties) SetWorkspaceId added in v1.44.140 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (RelatedWorkspaceProperties) String added in v1.44.140 

func (s RelatedWorkspaceProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceAlreadyExistsException added in v1.28.0 

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource already exists.

func (*ResourceAlreadyExistsException) Code added in v1.28.0 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error added in v1.28.0 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString added in v1.28.0 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message added in v1.28.0 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr added in v1.28.0 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID added in v1.28.0 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode added in v1.28.0 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String added in v1.28.0 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceAssociatedException added in v1.28.0 

type ResourceAssociatedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource is associated with a directory.

func (*ResourceAssociatedException) Code added in v1.28.0 

func (s *ResourceAssociatedException) Code() string

Code returns the exception type name.

func (*ResourceAssociatedException) Error added in v1.28.0 

func (s *ResourceAssociatedException) Error() string

func (ResourceAssociatedException) GoString added in v1.28.0 

func (s ResourceAssociatedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAssociatedException) Message added in v1.28.0 

func (s *ResourceAssociatedException) Message() string

Message returns the exception's message.

func (*ResourceAssociatedException) OrigErr added in v1.28.0 

func (s *ResourceAssociatedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAssociatedException) RequestID added in v1.28.0 

func (s *ResourceAssociatedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAssociatedException) StatusCode added in v1.28.0 

func (s *ResourceAssociatedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAssociatedException) String added in v1.28.0 

func (s ResourceAssociatedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceCreationFailedException added in v1.28.0 

type ResourceCreationFailedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The resource could not be created.

func (*ResourceCreationFailedException) Code added in v1.28.0 

func (s *ResourceCreationFailedException) Code() string

Code returns the exception type name.

func (*ResourceCreationFailedException) Error added in v1.28.0 

func (s *ResourceCreationFailedException) Error() string

func (ResourceCreationFailedException) GoString added in v1.28.0 

func (s ResourceCreationFailedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceCreationFailedException) Message added in v1.28.0 

func (s *ResourceCreationFailedException) Message() string

Message returns the exception's message.

func (*ResourceCreationFailedException) OrigErr added in v1.28.0 

func (s *ResourceCreationFailedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceCreationFailedException) RequestID added in v1.28.0 

func (s *ResourceCreationFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceCreationFailedException) StatusCode added in v1.28.0 

func (s *ResourceCreationFailedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceCreationFailedException) String added in v1.28.0 

func (s ResourceCreationFailedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceInUseException added in v1.45.23 

type ResourceInUseException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The ID of the resource that is in use.
	ResourceId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified resource is currently in use.

func (*ResourceInUseException) Code added in v1.45.23 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.45.23 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.45.23 

func (s ResourceInUseException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceInUseException) Message added in v1.45.23 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.45.23 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.45.23 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.45.23 

func (s *ResourceInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUseException) String added in v1.45.23 

func (s ResourceInUseException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceLimitExceededException added in v1.28.0 

type ResourceLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The exception error message.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Your resource limits have been exceeded.

func (*ResourceLimitExceededException) Code added in v1.28.0 

func (s *ResourceLimitExceededException) Code() string

Code returns the exception type name.

func (*ResourceLimitExceededException) Error added in v1.28.0 

func (s *ResourceLimitExceededException) Error() string

func (ResourceLimitExceededException) GoString added in v1.28.0 

func (s ResourceLimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceLimitExceededException) Message added in v1.28.0 

func (s *ResourceLimitExceededException) Message() string

Message returns the exception's message.

func (*ResourceLimitExceededException) OrigErr added in v1.28.0 

func (s *ResourceLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLimitExceededException) RequestID added in v1.28.0 

func (s *ResourceLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLimitExceededException) StatusCode added in v1.28.0 

func (s *ResourceLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceLimitExceededException) String added in v1.28.0 

func (s ResourceLimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException added in v1.28.0 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The resource could not be found.
	Message_ *string `locationName:"message" type:"string"`

	// The ID of the resource that could not be found.
	ResourceId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource could not be found.

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceUnavailableException added in v1.28.0 

type ResourceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The exception error message.
	Message_ *string `locationName:"message" type:"string"`

	// The identifier of the resource that is not available.
	ResourceId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified resource is not available.

func (*ResourceUnavailableException) Code added in v1.28.0 

func (s *ResourceUnavailableException) Code() string

Code returns the exception type name.

func (*ResourceUnavailableException) Error added in v1.28.0 

func (s *ResourceUnavailableException) Error() string

func (ResourceUnavailableException) GoString added in v1.28.0 

func (s ResourceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceUnavailableException) Message added in v1.28.0 

func (s *ResourceUnavailableException) Message() string

Message returns the exception's message.

func (*ResourceUnavailableException) OrigErr added in v1.28.0 

func (s *ResourceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceUnavailableException) RequestID added in v1.28.0 

func (s *ResourceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceUnavailableException) StatusCode added in v1.28.0 

func (s *ResourceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceUnavailableException) String added in v1.28.0 

func (s ResourceUnavailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreWorkspaceInput added in v1.20.11 

type RestoreWorkspaceInput struct {

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

func (RestoreWorkspaceInput) GoString added in v1.20.11 

func (s RestoreWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreWorkspaceInput) SetWorkspaceId added in v1.20.11 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (RestoreWorkspaceInput) String added in v1.20.11 

func (s RestoreWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreWorkspaceInput) Validate added in v1.20.11 

func (s *RestoreWorkspaceInput) Validate() error

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

type RestoreWorkspaceOutput added in v1.20.11 

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

func (RestoreWorkspaceOutput) GoString added in v1.20.11 

func (s RestoreWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RestoreWorkspaceOutput) String added in v1.20.11 

func (s RestoreWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RevokeIpRulesInput added in v1.13.39 

type RevokeIpRulesInput struct {

	// The identifier of the group.
	//
	// GroupId is a required field
	GroupId *string `type:"string" required:"true"`

	// The rules to remove from the group.
	//
	// UserRules is a required field
	UserRules []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RevokeIpRulesInput) GoString added in v1.13.39 

func (s RevokeIpRulesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RevokeIpRulesInput) SetGroupId added in v1.13.39 

func (s *RevokeIpRulesInput) SetGroupId(v string) *RevokeIpRulesInput

SetGroupId sets the GroupId field's value.

func (*RevokeIpRulesInput) SetUserRules added in v1.13.39 

func (s *RevokeIpRulesInput) SetUserRules(v []*string) *RevokeIpRulesInput

SetUserRules sets the UserRules field's value.

func (RevokeIpRulesInput) String added in v1.13.39 

func (s RevokeIpRulesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RevokeIpRulesInput) Validate added in v1.13.39 

func (s *RevokeIpRulesInput) Validate() error

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

type RevokeIpRulesOutput added in v1.13.39 

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

func (RevokeIpRulesOutput) GoString added in v1.13.39 

func (s RevokeIpRulesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (RevokeIpRulesOutput) String added in v1.13.39 

func (s RevokeIpRulesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RootStorage added in v1.12.54 

type RootStorage struct {

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

Describes the root volume for a WorkSpace bundle.

func (RootStorage) GoString added in v1.12.54 

func (s RootStorage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RootStorage) SetCapacity added in v1.12.54 

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

SetCapacity sets the Capacity field's value.

func (RootStorage) String added in v1.12.54 

func (s RootStorage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RootStorage) Validate added in v1.37.30 

func (s *RootStorage) Validate() error

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

type SamlProperties added in v1.44.67 

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 `min:"1" type:"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 *string `type:"string" enum:"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 `min:"8" type:"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.

func (SamlProperties) GoString added in v1.44.67 

func (s SamlProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SamlProperties) SetRelayStateParameterName added in v1.44.67 

func (s *SamlProperties) SetRelayStateParameterName(v string) *SamlProperties

SetRelayStateParameterName sets the RelayStateParameterName field's value.

func (*SamlProperties) SetStatus added in v1.44.67 

func (s *SamlProperties) SetStatus(v string) *SamlProperties

SetStatus sets the Status field's value.

func (*SamlProperties) SetUserAccessUrl added in v1.44.67 

func (s *SamlProperties) SetUserAccessUrl(v string) *SamlProperties

SetUserAccessUrl sets the UserAccessUrl field's value.

func (SamlProperties) String added in v1.44.67 

func (s SamlProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SamlProperties) Validate added in v1.44.67 

func (s *SamlProperties) Validate() error

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

type SelfservicePermissions added in v1.25.36 

type SelfservicePermissions struct {

	// Specifies whether users can change the compute type (bundle) for their WorkSpace.
	ChangeComputeType *string `type:"string" enum:"ReconnectEnum"`

	// Specifies whether users can increase the volume size of the drives on their
	// WorkSpace.
	IncreaseVolumeSize *string `type:"string" enum:"ReconnectEnum"`

	// Specifies whether users can rebuild the operating system of a WorkSpace to
	// its original state.
	RebuildWorkspace *string `type:"string" enum:"ReconnectEnum"`

	// Specifies whether users can restart their WorkSpace.
	RestartWorkspace *string `type:"string" enum:"ReconnectEnum"`

	// Specifies whether users can switch the running mode of their WorkSpace.
	SwitchRunningMode *string `type:"string" enum:"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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html).

func (SelfservicePermissions) GoString added in v1.25.36 

func (s SelfservicePermissions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SelfservicePermissions) SetChangeComputeType added in v1.25.36 

func (s *SelfservicePermissions) SetChangeComputeType(v string) *SelfservicePermissions

SetChangeComputeType sets the ChangeComputeType field's value.

func (*SelfservicePermissions) SetIncreaseVolumeSize added in v1.25.36 

func (s *SelfservicePermissions) SetIncreaseVolumeSize(v string) *SelfservicePermissions

SetIncreaseVolumeSize sets the IncreaseVolumeSize field's value.

func (*SelfservicePermissions) SetRebuildWorkspace added in v1.25.36 

func (s *SelfservicePermissions) SetRebuildWorkspace(v string) *SelfservicePermissions

SetRebuildWorkspace sets the RebuildWorkspace field's value.

func (*SelfservicePermissions) SetRestartWorkspace added in v1.25.36 

func (s *SelfservicePermissions) SetRestartWorkspace(v string) *SelfservicePermissions

SetRestartWorkspace sets the RestartWorkspace field's value.

func (*SelfservicePermissions) SetSwitchRunningMode added in v1.25.36 

func (s *SelfservicePermissions) SetSwitchRunningMode(v string) *SelfservicePermissions

SetSwitchRunningMode sets the SwitchRunningMode field's value.

func (SelfservicePermissions) String added in v1.25.36 

func (s SelfservicePermissions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Snapshot added in v1.20.11 

type Snapshot struct {

	// The time when the snapshot was created.
	SnapshotTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Describes a snapshot.

func (Snapshot) GoString added in v1.20.11 

func (s Snapshot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Snapshot) SetSnapshotTime added in v1.20.11 

func (s *Snapshot) SetSnapshotTime(v time.Time) *Snapshot

SetSnapshotTime sets the SnapshotTime field's value.

func (Snapshot) String added in v1.20.11 

func (s Snapshot) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StandbyWorkspace added in v1.44.140 

type StandbyWorkspace struct {

	// Indicates whether data replication is enabled, and if enabled, the type of
	// data replication.
	DataReplication *string `type:"string" enum:"DataReplication"`

	// The identifier of the directory for the standby WorkSpace.
	//
	// DirectoryId is a required field
	DirectoryId *string `min:"10" type:"string" required:"true"`

	// The identifier of the standby WorkSpace.
	//
	// PrimaryWorkspaceId is a required field
	PrimaryWorkspaceId *string `type:"string" required:"true"`

	// The tags associated with the standby WorkSpace.
	Tags []*Tag `type:"list"`

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

Describes a standby WorkSpace.

func (StandbyWorkspace) GoString added in v1.44.140 

func (s StandbyWorkspace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandbyWorkspace) SetDataReplication added in v1.48.4 

func (s *StandbyWorkspace) SetDataReplication(v string) *StandbyWorkspace

SetDataReplication sets the DataReplication field's value.

func (*StandbyWorkspace) SetDirectoryId added in v1.44.140 

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

SetDirectoryId sets the DirectoryId field's value.

func (*StandbyWorkspace) SetPrimaryWorkspaceId added in v1.44.140 

func (s *StandbyWorkspace) SetPrimaryWorkspaceId(v string) *StandbyWorkspace

SetPrimaryWorkspaceId sets the PrimaryWorkspaceId field's value.

func (*StandbyWorkspace) SetTags added in v1.44.140 

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

SetTags sets the Tags field's value.

func (*StandbyWorkspace) SetVolumeEncryptionKey added in v1.44.140 

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

SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.

func (StandbyWorkspace) String added in v1.44.140 

func (s StandbyWorkspace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandbyWorkspace) Validate added in v1.44.140 

func (s *StandbyWorkspace) Validate() error

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

type StandbyWorkspacesProperties added in v1.48.4 

type StandbyWorkspacesProperties struct {

	// Indicates whether data replication is enabled, and if enabled, the type of
	// data replication.
	DataReplication *string `type:"string" enum:"DataReplication"`

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

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

Describes the properties of the related standby WorkSpaces.

func (StandbyWorkspacesProperties) GoString added in v1.48.4 

func (s StandbyWorkspacesProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StandbyWorkspacesProperties) SetDataReplication added in v1.48.4 

func (s *StandbyWorkspacesProperties) SetDataReplication(v string) *StandbyWorkspacesProperties

SetDataReplication sets the DataReplication field's value.

func (*StandbyWorkspacesProperties) SetRecoverySnapshotTime added in v1.48.4 

func (s *StandbyWorkspacesProperties) SetRecoverySnapshotTime(v time.Time) *StandbyWorkspacesProperties

SetRecoverySnapshotTime sets the RecoverySnapshotTime field's value.

func (*StandbyWorkspacesProperties) SetStandbyWorkspaceId added in v1.48.4 

func (s *StandbyWorkspacesProperties) SetStandbyWorkspaceId(v string) *StandbyWorkspacesProperties

SetStandbyWorkspaceId sets the StandbyWorkspaceId field's value.

func (StandbyWorkspacesProperties) String added in v1.48.4 

func (s StandbyWorkspacesProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartRequest added in v1.4.3 

type StartRequest struct {

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

Information used to start a WorkSpace.

func (StartRequest) GoString added in v1.4.3 

func (s StartRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartRequest) SetWorkspaceId added in v1.5.0 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (StartRequest) String added in v1.4.3 

func (s StartRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartWorkspacesInput added in v1.4.3 

type StartWorkspacesInput struct {

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

func (StartWorkspacesInput) GoString added in v1.4.3 

func (s StartWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartWorkspacesInput) SetStartWorkspaceRequests added in v1.5.0 

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

SetStartWorkspaceRequests sets the StartWorkspaceRequests field's value.

func (StartWorkspacesInput) String added in v1.4.3 

func (s StartWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartWorkspacesInput) Validate added in v1.4.3 

func (s *StartWorkspacesInput) Validate() error

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

type StartWorkspacesOutput added in v1.4.3 

type StartWorkspacesOutput struct {

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

func (StartWorkspacesOutput) GoString added in v1.4.3 

func (s StartWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartWorkspacesOutput) SetFailedRequests added in v1.5.0 

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

SetFailedRequests sets the FailedRequests field's value.

func (StartWorkspacesOutput) String added in v1.4.3 

func (s StartWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopRequest added in v1.4.3 

type StopRequest struct {

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

Describes the information used to stop a WorkSpace.

func (StopRequest) GoString added in v1.4.3 

func (s StopRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopRequest) SetWorkspaceId added in v1.5.0 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (StopRequest) String added in v1.4.3 

func (s StopRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopWorkspacesInput added in v1.4.3 

type StopWorkspacesInput struct {

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

func (StopWorkspacesInput) GoString added in v1.4.3 

func (s StopWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopWorkspacesInput) SetStopWorkspaceRequests added in v1.5.0 

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

SetStopWorkspaceRequests sets the StopWorkspaceRequests field's value.

func (StopWorkspacesInput) String added in v1.4.3 

func (s StopWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopWorkspacesInput) Validate added in v1.4.3 

func (s *StopWorkspacesInput) Validate() error

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

type StopWorkspacesOutput added in v1.4.3 

type StopWorkspacesOutput struct {

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

func (StopWorkspacesOutput) GoString added in v1.4.3 

func (s StopWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopWorkspacesOutput) SetFailedRequests added in v1.5.0 

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

SetFailedRequests sets the FailedRequests field's value.

func (StopWorkspacesOutput) String added in v1.4.3 

func (s StopWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Tag added in v1.1.27 

type Tag struct {

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

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

Describes a tag.

func (Tag) GoString added in v1.1.27 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey added in v1.5.0 

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

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.5.0 

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

SetValue sets the Value field's value.

func (Tag) String added in v1.1.27 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate added in v1.1.27 

func (s *Tag) Validate() error

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

type TerminateRequest 

type TerminateRequest struct {

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

Describes the information used to terminate a WorkSpace.

func (TerminateRequest) GoString added in v0.6.5 

func (s TerminateRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateRequest) SetWorkspaceId added in v1.5.0 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (TerminateRequest) String added in v0.6.5 

func (s TerminateRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateRequest) Validate added in v1.1.21 

func (s *TerminateRequest) Validate() error

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

type TerminateWorkspacesInput 

type TerminateWorkspacesInput struct {

	// The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
	//
	// TerminateWorkspaceRequests is a required field
	TerminateWorkspaceRequests []*TerminateRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TerminateWorkspacesInput) GoString added in v0.6.5 

func (s TerminateWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateWorkspacesInput) SetTerminateWorkspaceRequests added in v1.5.0 

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

SetTerminateWorkspaceRequests sets the TerminateWorkspaceRequests field's value.

func (TerminateWorkspacesInput) String added in v0.6.5 

func (s TerminateWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateWorkspacesInput) Validate added in v1.1.21 

func (s *TerminateWorkspacesInput) Validate() error

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

type TerminateWorkspacesOutput 

type TerminateWorkspacesOutput struct {

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

func (TerminateWorkspacesOutput) GoString added in v0.6.5 

func (s TerminateWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TerminateWorkspacesOutput) SetFailedRequests added in v1.5.0 

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

SetFailedRequests sets the FailedRequests field's value.

func (TerminateWorkspacesOutput) String added in v0.6.5 

func (s TerminateWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnsupportedNetworkConfigurationException added in v1.28.0 

type UnsupportedNetworkConfigurationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html).

func (*UnsupportedNetworkConfigurationException) Code added in v1.28.0 

func (s *UnsupportedNetworkConfigurationException) Code() string

Code returns the exception type name.

func (*UnsupportedNetworkConfigurationException) Error added in v1.28.0 

func (s *UnsupportedNetworkConfigurationException) Error() string

func (UnsupportedNetworkConfigurationException) GoString added in v1.28.0 

func (s UnsupportedNetworkConfigurationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedNetworkConfigurationException) Message added in v1.28.0 

func (s *UnsupportedNetworkConfigurationException) Message() string

Message returns the exception's message.

func (*UnsupportedNetworkConfigurationException) OrigErr added in v1.28.0 

func (s *UnsupportedNetworkConfigurationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedNetworkConfigurationException) RequestID added in v1.28.0 

func (s *UnsupportedNetworkConfigurationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedNetworkConfigurationException) StatusCode added in v1.28.0 

func (s *UnsupportedNetworkConfigurationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedNetworkConfigurationException) String added in v1.28.0 

func (s UnsupportedNetworkConfigurationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnsupportedWorkspaceConfigurationException added in v1.28.0 

type UnsupportedWorkspaceConfigurationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html).

func (*UnsupportedWorkspaceConfigurationException) Code added in v1.28.0 

func (s *UnsupportedWorkspaceConfigurationException) Code() string

Code returns the exception type name.

func (*UnsupportedWorkspaceConfigurationException) Error added in v1.28.0 

func (s *UnsupportedWorkspaceConfigurationException) Error() string

func (UnsupportedWorkspaceConfigurationException) GoString added in v1.28.0 

func (s UnsupportedWorkspaceConfigurationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedWorkspaceConfigurationException) Message added in v1.28.0 

func (s *UnsupportedWorkspaceConfigurationException) Message() string

Message returns the exception's message.

func (*UnsupportedWorkspaceConfigurationException) OrigErr added in v1.28.0 

func (s *UnsupportedWorkspaceConfigurationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedWorkspaceConfigurationException) RequestID added in v1.28.0 

func (s *UnsupportedWorkspaceConfigurationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedWorkspaceConfigurationException) StatusCode added in v1.28.0 

func (s *UnsupportedWorkspaceConfigurationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedWorkspaceConfigurationException) String added in v1.28.0 

func (s UnsupportedWorkspaceConfigurationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateConnectClientAddInInput added in v1.42.32 

type UpdateConnectClientAddInInput struct {

	// The identifier of the client add-in to update.
	//
	// AddInId is a required field
	AddInId *string `min:"36" type:"string" required:"true"`

	// The name of the client add-in.
	Name *string `min:"1" type:"string"`

	// The directory identifier for which the client add-in is configured.
	//
	// ResourceId is a required field
	ResourceId *string `min:"10" type:"string" required:"true"`

	// The endpoint URL of the Amazon Connect client add-in.
	URL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateConnectClientAddInInput) GoString added in v1.42.32 

func (s UpdateConnectClientAddInInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectClientAddInInput) SetAddInId added in v1.42.32 

func (s *UpdateConnectClientAddInInput) SetAddInId(v string) *UpdateConnectClientAddInInput

SetAddInId sets the AddInId field's value.

func (*UpdateConnectClientAddInInput) SetName added in v1.42.32 

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

SetName sets the Name field's value.

func (*UpdateConnectClientAddInInput) SetResourceId added in v1.42.32 

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

SetResourceId sets the ResourceId field's value.

func (*UpdateConnectClientAddInInput) SetURL added in v1.42.32 

func (s *UpdateConnectClientAddInInput) SetURL(v string) *UpdateConnectClientAddInInput

SetURL sets the URL field's value.

func (UpdateConnectClientAddInInput) String added in v1.42.32 

func (s UpdateConnectClientAddInInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectClientAddInInput) Validate added in v1.42.32 

func (s *UpdateConnectClientAddInInput) Validate() error

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

type UpdateConnectClientAddInOutput added in v1.42.32 

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

func (UpdateConnectClientAddInOutput) GoString added in v1.42.32 

func (s UpdateConnectClientAddInOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateConnectClientAddInOutput) String added in v1.42.32 

func (s UpdateConnectClientAddInOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateConnectionAliasPermissionInput added in v1.34.22 

type UpdateConnectionAliasPermissionInput struct {

	// The identifier of the connection alias that you want to update permissions
	// for.
	//
	// AliasId is a required field
	AliasId *string `min:"13" type:"string" required:"true"`

	// Indicates whether to share or unshare the connection alias with the specified
	// Amazon Web Services account.
	//
	// ConnectionAliasPermission is a required field
	ConnectionAliasPermission *ConnectionAliasPermission `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateConnectionAliasPermissionInput) GoString added in v1.34.22 

func (s UpdateConnectionAliasPermissionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionAliasPermissionInput) SetAliasId added in v1.34.22 

func (s *UpdateConnectionAliasPermissionInput) SetAliasId(v string) *UpdateConnectionAliasPermissionInput

SetAliasId sets the AliasId field's value.

func (*UpdateConnectionAliasPermissionInput) SetConnectionAliasPermission added in v1.34.22 

func (s *UpdateConnectionAliasPermissionInput) SetConnectionAliasPermission(v *ConnectionAliasPermission) *UpdateConnectionAliasPermissionInput

SetConnectionAliasPermission sets the ConnectionAliasPermission field's value.

func (UpdateConnectionAliasPermissionInput) String added in v1.34.22 

func (s UpdateConnectionAliasPermissionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateConnectionAliasPermissionInput) Validate added in v1.34.22 

func (s *UpdateConnectionAliasPermissionInput) Validate() error

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

type UpdateConnectionAliasPermissionOutput added in v1.34.22 

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

func (UpdateConnectionAliasPermissionOutput) GoString added in v1.34.22 

func (s UpdateConnectionAliasPermissionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateConnectionAliasPermissionOutput) String added in v1.34.22 

func (s UpdateConnectionAliasPermissionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateResult added in v1.40.53 

type UpdateResult struct {

	// A description of whether updates for the WorkSpace image are pending or available.
	Description *string `min:"1" type:"string"`

	// Indicates whether updated drivers or other components are available for the
	// specified WorkSpace image.
	UpdateAvailable *bool `type:"boolean"`
	// 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.

func (UpdateResult) GoString added in v1.40.53 

func (s UpdateResult) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateResult) SetDescription added in v1.40.53 

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

SetDescription sets the Description field's value.

func (*UpdateResult) SetUpdateAvailable added in v1.40.53 

func (s *UpdateResult) SetUpdateAvailable(v bool) *UpdateResult

SetUpdateAvailable sets the UpdateAvailable field's value.

func (UpdateResult) String added in v1.40.53 

func (s UpdateResult) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRulesOfIpGroupInput added in v1.13.39 

type UpdateRulesOfIpGroupInput struct {

	// The identifier of the group.
	//
	// GroupId is a required field
	GroupId *string `type:"string" required:"true"`

	// One or more rules.
	//
	// UserRules is a required field
	UserRules []*IpRuleItem `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRulesOfIpGroupInput) GoString added in v1.13.39 

func (s UpdateRulesOfIpGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRulesOfIpGroupInput) SetGroupId added in v1.13.39 

func (s *UpdateRulesOfIpGroupInput) SetGroupId(v string) *UpdateRulesOfIpGroupInput

SetGroupId sets the GroupId field's value.

func (*UpdateRulesOfIpGroupInput) SetUserRules added in v1.13.39 

func (s *UpdateRulesOfIpGroupInput) SetUserRules(v []*IpRuleItem) *UpdateRulesOfIpGroupInput

SetUserRules sets the UserRules field's value.

func (UpdateRulesOfIpGroupInput) String added in v1.13.39 

func (s UpdateRulesOfIpGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRulesOfIpGroupInput) Validate added in v1.13.39 

func (s *UpdateRulesOfIpGroupInput) Validate() error

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

type UpdateRulesOfIpGroupOutput added in v1.13.39 

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

func (UpdateRulesOfIpGroupOutput) GoString added in v1.13.39 

func (s UpdateRulesOfIpGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateRulesOfIpGroupOutput) String added in v1.13.39 

func (s UpdateRulesOfIpGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkspaceBundleInput added in v1.37.30 

type UpdateWorkspaceBundleInput struct {

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

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

func (UpdateWorkspaceBundleInput) GoString added in v1.37.30 

func (s UpdateWorkspaceBundleInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceBundleInput) SetBundleId added in v1.37.30 

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

SetBundleId sets the BundleId field's value.

func (*UpdateWorkspaceBundleInput) SetImageId added in v1.37.30 

func (s *UpdateWorkspaceBundleInput) SetImageId(v string) *UpdateWorkspaceBundleInput

SetImageId sets the ImageId field's value.

func (UpdateWorkspaceBundleInput) String added in v1.37.30 

func (s UpdateWorkspaceBundleInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkspaceBundleOutput added in v1.37.30 

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

func (UpdateWorkspaceBundleOutput) GoString added in v1.37.30 

func (s UpdateWorkspaceBundleOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateWorkspaceBundleOutput) String added in v1.37.30 

func (s UpdateWorkspaceBundleOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkspaceImagePermissionInput added in v1.33.11 

type UpdateWorkspaceImagePermissionInput struct {

	// The permission to copy the image. This permission can be revoked only after
	// an image has been shared.
	//
	// AllowCopyImage is a required field
	AllowCopyImage *bool `type:"boolean" required:"true"`

	// The identifier of the image.
	//
	// ImageId is a required field
	ImageId *string `type:"string" required:"true"`

	// The identifier of the Amazon Web Services account to share or unshare the
	// image with.
	//
	// Before sharing the image, confirm that you are sharing to the correct Amazon
	// Web Services account ID.
	//
	// SharedAccountId is a required field
	SharedAccountId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkspaceImagePermissionInput) GoString added in v1.33.11 

func (s UpdateWorkspaceImagePermissionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceImagePermissionInput) SetAllowCopyImage added in v1.33.11 

func (s *UpdateWorkspaceImagePermissionInput) SetAllowCopyImage(v bool) *UpdateWorkspaceImagePermissionInput

SetAllowCopyImage sets the AllowCopyImage field's value.

func (*UpdateWorkspaceImagePermissionInput) SetImageId added in v1.33.11 

func (s *UpdateWorkspaceImagePermissionInput) SetImageId(v string) *UpdateWorkspaceImagePermissionInput

SetImageId sets the ImageId field's value.

func (*UpdateWorkspaceImagePermissionInput) SetSharedAccountId added in v1.33.11 

func (s *UpdateWorkspaceImagePermissionInput) SetSharedAccountId(v string) *UpdateWorkspaceImagePermissionInput

SetSharedAccountId sets the SharedAccountId field's value.

func (UpdateWorkspaceImagePermissionInput) String added in v1.33.11 

func (s UpdateWorkspaceImagePermissionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceImagePermissionInput) Validate added in v1.33.11 

func (s *UpdateWorkspaceImagePermissionInput) Validate() error

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

type UpdateWorkspaceImagePermissionOutput added in v1.33.11 

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

func (UpdateWorkspaceImagePermissionOutput) GoString added in v1.33.11 

func (s UpdateWorkspaceImagePermissionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateWorkspaceImagePermissionOutput) String added in v1.33.11 

func (s UpdateWorkspaceImagePermissionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserStorage 

type UserStorage struct {

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

Describes the user volume for a WorkSpace bundle.

func (UserStorage) GoString added in v0.6.5 

func (s UserStorage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserStorage) SetCapacity added in v1.5.0 

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

SetCapacity sets the Capacity field's value.

func (UserStorage) String added in v0.6.5 

func (s UserStorage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserStorage) Validate added in v1.37.30 

func (s *UserStorage) Validate() error

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

type WorkSpaceApplication added in v1.45.23 

type WorkSpaceApplication struct {

	// The identifier of the application.
	ApplicationId *string `type:"string"`

	// The time the application is created.
	Created *time.Time `type:"timestamp"`

	// The description of the WorkSpace application.
	Description *string `type:"string"`

	// The license availability for the applications.
	LicenseType *string `type:"string" enum:"WorkSpaceApplicationLicenseType"`

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

	// The owner of the WorkSpace application.
	Owner *string `type:"string"`

	// The status of WorkSpace application.
	State *string `type:"string" enum:"WorkSpaceApplicationState"`

	// The supported compute types of the WorkSpace application.
	SupportedComputeTypeNames []*string `type:"list" enum:"Compute"`

	// The supported operating systems of the WorkSpace application.
	SupportedOperatingSystemNames []*string `type:"list" enum:"OperatingSystemName"`
	// contains filtered or unexported fields
}

Describes the WorkSpace application.

func (WorkSpaceApplication) GoString added in v1.45.23 

func (s WorkSpaceApplication) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkSpaceApplication) SetApplicationId added in v1.45.23 

func (s *WorkSpaceApplication) SetApplicationId(v string) *WorkSpaceApplication

SetApplicationId sets the ApplicationId field's value.

func (*WorkSpaceApplication) SetCreated added in v1.45.23 

func (s *WorkSpaceApplication) SetCreated(v time.Time) *WorkSpaceApplication

SetCreated sets the Created field's value.

func (*WorkSpaceApplication) SetDescription added in v1.45.23 

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

SetDescription sets the Description field's value.

func (*WorkSpaceApplication) SetLicenseType added in v1.45.23 

func (s *WorkSpaceApplication) SetLicenseType(v string) *WorkSpaceApplication

SetLicenseType sets the LicenseType field's value.

func (*WorkSpaceApplication) SetName added in v1.45.23 

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

SetName sets the Name field's value.

func (*WorkSpaceApplication) SetOwner added in v1.45.23 

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

SetOwner sets the Owner field's value.

func (*WorkSpaceApplication) SetState added in v1.45.23 

func (s *WorkSpaceApplication) SetState(v string) *WorkSpaceApplication

SetState sets the State field's value.

func (*WorkSpaceApplication) SetSupportedComputeTypeNames added in v1.45.23 

func (s *WorkSpaceApplication) SetSupportedComputeTypeNames(v []*string) *WorkSpaceApplication

SetSupportedComputeTypeNames sets the SupportedComputeTypeNames field's value.

func (*WorkSpaceApplication) SetSupportedOperatingSystemNames added in v1.45.23 

func (s *WorkSpaceApplication) SetSupportedOperatingSystemNames(v []*string) *WorkSpaceApplication

SetSupportedOperatingSystemNames sets the SupportedOperatingSystemNames field's value.

func (WorkSpaceApplication) String added in v1.45.23 

func (s WorkSpaceApplication) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkSpaceApplicationDeployment added in v1.45.23 

type WorkSpaceApplicationDeployment struct {

	// The associations between the applications and the associated resources.
	Associations []*WorkspaceResourceAssociation `type:"list"`
	// contains filtered or unexported fields
}

Describes the WorkSpace application deployment.

func (WorkSpaceApplicationDeployment) GoString added in v1.45.23 

func (s WorkSpaceApplicationDeployment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkSpaceApplicationDeployment) SetAssociations added in v1.45.23 

func (s *WorkSpaceApplicationDeployment) SetAssociations(v []*WorkspaceResourceAssociation) *WorkSpaceApplicationDeployment

SetAssociations sets the Associations field's value.

func (WorkSpaceApplicationDeployment) String added in v1.45.23 

func (s WorkSpaceApplicationDeployment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkSpaces 

type WorkSpaces struct {
	*client.Client
}

WorkSpaces provides the API operation methods for making requests to Amazon WorkSpaces. See this package's package overview docs for details on the service.

WorkSpaces methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *WorkSpaces

New creates a new instance of the WorkSpaces client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a WorkSpaces client from just a session.
svc := workspaces.New(mySession)

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

func (*WorkSpaces) AssociateConnectionAlias added in v1.34.22 

func (c *WorkSpaces) AssociateConnectionAlias(input *AssociateConnectionAliasInput) (*AssociateConnectionAliasOutput, error)

AssociateConnectionAlias API operation for Amazon WorkSpaces.

Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) to make sure that the current state of the connection alias is CREATED.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation AssociateConnectionAlias for usage and error information.

Returned Error Types:

  • ResourceAssociatedException The resource is associated with a directory.

  • AccessDeniedException The user is not authorized to access a resource.

  • ResourceNotFoundException The resource could not be found.

  • InvalidParameterValuesException One or more parameter values are not valid.

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

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateConnectionAlias

func (*WorkSpaces) AssociateConnectionAliasRequest added in v1.34.22 

func (c *WorkSpaces) AssociateConnectionAliasRequest(input *AssociateConnectionAliasInput) (req *request.Request, output *AssociateConnectionAliasOutput)

AssociateConnectionAliasRequest generates a "aws/request.Request" representing the client's request for the AssociateConnectionAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateConnectionAlias for more information on using the AssociateConnectionAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateConnectionAliasRequest method.
req, resp := client.AssociateConnectionAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateConnectionAlias

func (*WorkSpaces) AssociateConnectionAliasWithContext added in v1.34.22 

func (c *WorkSpaces) AssociateConnectionAliasWithContext(ctx aws.Context, input *AssociateConnectionAliasInput, opts ...request.Option) (*AssociateConnectionAliasOutput, error)

AssociateConnectionAliasWithContext is the same as AssociateConnectionAlias with the addition of the ability to pass a context and additional request options.

See AssociateConnectionAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) AssociateIpGroups added in v1.13.39 

func (c *WorkSpaces) AssociateIpGroups(input *AssociateIpGroupsInput) (*AssociateIpGroupsOutput, error)

AssociateIpGroups API operation for Amazon WorkSpaces.

Associates the specified IP access control group with the specified directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation AssociateIpGroups for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • ResourceLimitExceededException Your resource limits have been exceeded.

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

  • AccessDeniedException The user is not authorized to access a resource.

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateIpGroups

func (*WorkSpaces) AssociateIpGroupsRequest added in v1.13.39 

func (c *WorkSpaces) AssociateIpGroupsRequest(input *AssociateIpGroupsInput) (req *request.Request, output *AssociateIpGroupsOutput)

AssociateIpGroupsRequest generates a "aws/request.Request" representing the client's request for the AssociateIpGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateIpGroups for more information on using the AssociateIpGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateIpGroupsRequest method.
req, resp := client.AssociateIpGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateIpGroups

func (*WorkSpaces) AssociateIpGroupsWithContext added in v1.13.39 

func (c *WorkSpaces) AssociateIpGroupsWithContext(ctx aws.Context, input *AssociateIpGroupsInput, opts ...request.Option) (*AssociateIpGroupsOutput, error)

AssociateIpGroupsWithContext is the same as AssociateIpGroups with the addition of the ability to pass a context and additional request options.

See AssociateIpGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) AssociateWorkspaceApplication added in v1.45.23 

func (c *WorkSpaces) AssociateWorkspaceApplication(input *AssociateWorkspaceApplicationInput) (*AssociateWorkspaceApplicationOutput, error)

AssociateWorkspaceApplication API operation for Amazon WorkSpaces.

Associates the specified application to the specified WorkSpace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation AssociateWorkspaceApplication for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceInUseException The specified resource is currently in use.

  • ResourceNotFoundException The resource could not be found.

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

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

  • ApplicationNotSupportedException The specified application is not supported.

  • IncompatibleApplicationsException The specified application is not compatible with the resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateWorkspaceApplication

func (*WorkSpaces) AssociateWorkspaceApplicationRequest added in v1.45.23 

func (c *WorkSpaces) AssociateWorkspaceApplicationRequest(input *AssociateWorkspaceApplicationInput) (req *request.Request, output *AssociateWorkspaceApplicationOutput)

AssociateWorkspaceApplicationRequest generates a "aws/request.Request" representing the client's request for the AssociateWorkspaceApplication operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateWorkspaceApplication for more information on using the AssociateWorkspaceApplication API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateWorkspaceApplicationRequest method.
req, resp := client.AssociateWorkspaceApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateWorkspaceApplication

func (*WorkSpaces) AssociateWorkspaceApplicationWithContext added in v1.45.23 

func (c *WorkSpaces) AssociateWorkspaceApplicationWithContext(ctx aws.Context, input *AssociateWorkspaceApplicationInput, opts ...request.Option) (*AssociateWorkspaceApplicationOutput, error)

AssociateWorkspaceApplicationWithContext is the same as AssociateWorkspaceApplication with the addition of the ability to pass a context and additional request options.

See AssociateWorkspaceApplication for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) AuthorizeIpRules added in v1.13.39 

func (c *WorkSpaces) AuthorizeIpRules(input *AuthorizeIpRulesInput) (*AuthorizeIpRulesOutput, error)

AuthorizeIpRules API operation for Amazon WorkSpaces.

Adds one or more rules to the specified IP access control group.

This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation AuthorizeIpRules for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • ResourceLimitExceededException Your resource limits have been exceeded.

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

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AuthorizeIpRules

func (*WorkSpaces) AuthorizeIpRulesRequest added in v1.13.39 

func (c *WorkSpaces) AuthorizeIpRulesRequest(input *AuthorizeIpRulesInput) (req *request.Request, output *AuthorizeIpRulesOutput)

AuthorizeIpRulesRequest generates a "aws/request.Request" representing the client's request for the AuthorizeIpRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AuthorizeIpRules for more information on using the AuthorizeIpRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AuthorizeIpRulesRequest method.
req, resp := client.AuthorizeIpRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AuthorizeIpRules

func (*WorkSpaces) AuthorizeIpRulesWithContext added in v1.13.39 

func (c *WorkSpaces) AuthorizeIpRulesWithContext(ctx aws.Context, input *AuthorizeIpRulesInput, opts ...request.Option) (*AuthorizeIpRulesOutput, error)

AuthorizeIpRulesWithContext is the same as AuthorizeIpRules with the addition of the ability to pass a context and additional request options.

See AuthorizeIpRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CopyWorkspaceImage added in v1.20.11 

func (c *WorkSpaces) CopyWorkspaceImage(input *CopyWorkspaceImageInput) (*CopyWorkspaceImageOutput, error)

CopyWorkspaceImage API operation for Amazon WorkSpaces.

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html).

In the China (Ningxia) Region, you can copy images only within the same Region.

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html) and DescribeWorkspaceImagePermissions (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html) API operations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CopyWorkspaceImage for usage and error information.

Returned Error Types:

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceNotFoundException The resource could not be found.

  • ResourceUnavailableException The specified resource is not available.

  • OperationNotSupportedException This operation is not supported.

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CopyWorkspaceImage

func (*WorkSpaces) CopyWorkspaceImageRequest added in v1.20.11 

func (c *WorkSpaces) CopyWorkspaceImageRequest(input *CopyWorkspaceImageInput) (req *request.Request, output *CopyWorkspaceImageOutput)

CopyWorkspaceImageRequest generates a "aws/request.Request" representing the client's request for the CopyWorkspaceImage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopyWorkspaceImage for more information on using the CopyWorkspaceImage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CopyWorkspaceImageRequest method.
req, resp := client.CopyWorkspaceImageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CopyWorkspaceImage

func (*WorkSpaces) CopyWorkspaceImageWithContext added in v1.20.11 

func (c *WorkSpaces) CopyWorkspaceImageWithContext(ctx aws.Context, input *CopyWorkspaceImageInput, opts ...request.Option) (*CopyWorkspaceImageOutput, error)

CopyWorkspaceImageWithContext is the same as CopyWorkspaceImage with the addition of the ability to pass a context and additional request options.

See CopyWorkspaceImage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CreateConnectClientAddIn added in v1.42.32 

func (c *WorkSpaces) CreateConnectClientAddIn(input *CreateConnectClientAddInInput) (*CreateConnectClientAddInOutput, error)

CreateConnectClientAddIn API operation for Amazon WorkSpaces.

Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.

This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CreateConnectClientAddIn for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • ResourceCreationFailedException The resource could not be created.

  • ResourceAlreadyExistsException The specified resource already exists.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateConnectClientAddIn

func (*WorkSpaces) CreateConnectClientAddInRequest added in v1.42.32 

func (c *WorkSpaces) CreateConnectClientAddInRequest(input *CreateConnectClientAddInInput) (req *request.Request, output *CreateConnectClientAddInOutput)

CreateConnectClientAddInRequest generates a "aws/request.Request" representing the client's request for the CreateConnectClientAddIn operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConnectClientAddIn for more information on using the CreateConnectClientAddIn API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateConnectClientAddInRequest method.
req, resp := client.CreateConnectClientAddInRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateConnectClientAddIn

func (*WorkSpaces) CreateConnectClientAddInWithContext added in v1.42.32 

func (c *WorkSpaces) CreateConnectClientAddInWithContext(ctx aws.Context, input *CreateConnectClientAddInInput, opts ...request.Option) (*CreateConnectClientAddInOutput, error)

CreateConnectClientAddInWithContext is the same as CreateConnectClientAddIn with the addition of the ability to pass a context and additional request options.

See CreateConnectClientAddIn for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CreateConnectionAlias added in v1.34.22 

func (c *WorkSpaces) CreateConnectionAlias(input *CreateConnectionAliasInput) (*CreateConnectionAliasOutput, error)

CreateConnectionAlias API operation for Amazon WorkSpaces.

Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CreateConnectionAlias for usage and error information.

Returned Error Types:

  • ResourceAlreadyExistsException The specified resource already exists.

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceLimitExceededException Your resource limits have been exceeded.

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

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateConnectionAlias

func (*WorkSpaces) CreateConnectionAliasRequest added in v1.34.22 

func (c *WorkSpaces) CreateConnectionAliasRequest(input *CreateConnectionAliasInput) (req *request.Request, output *CreateConnectionAliasOutput)

CreateConnectionAliasRequest generates a "aws/request.Request" representing the client's request for the CreateConnectionAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateConnectionAlias for more information on using the CreateConnectionAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateConnectionAliasRequest method.
req, resp := client.CreateConnectionAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateConnectionAlias

func (*WorkSpaces) CreateConnectionAliasWithContext added in v1.34.22 

func (c *WorkSpaces) CreateConnectionAliasWithContext(ctx aws.Context, input *CreateConnectionAliasInput, opts ...request.Option) (*CreateConnectionAliasOutput, error)

CreateConnectionAliasWithContext is the same as CreateConnectionAlias with the addition of the ability to pass a context and additional request options.

See CreateConnectionAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CreateIpGroup added in v1.13.39 

func (c *WorkSpaces) CreateIpGroup(input *CreateIpGroupInput) (*CreateIpGroupOutput, error)

CreateIpGroup API operation for Amazon WorkSpaces.

Creates an IP access control group.

An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CreateIpGroup for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceCreationFailedException The resource could not be created.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateIpGroup

func (*WorkSpaces) CreateIpGroupRequest added in v1.13.39 

func (c *WorkSpaces) CreateIpGroupRequest(input *CreateIpGroupInput) (req *request.Request, output *CreateIpGroupOutput)

CreateIpGroupRequest generates a "aws/request.Request" representing the client's request for the CreateIpGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateIpGroup for more information on using the CreateIpGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateIpGroupRequest method.
req, resp := client.CreateIpGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateIpGroup

func (*WorkSpaces) CreateIpGroupWithContext added in v1.13.39 

func (c *WorkSpaces) CreateIpGroupWithContext(ctx aws.Context, input *CreateIpGroupInput, opts ...request.Option) (*CreateIpGroupOutput, error)

CreateIpGroupWithContext is the same as CreateIpGroup with the addition of the ability to pass a context and additional request options.

See CreateIpGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CreateStandbyWorkspaces added in v1.44.140 

func (c *WorkSpaces) CreateStandbyWorkspaces(input *CreateStandbyWorkspacesInput) (*CreateStandbyWorkspacesOutput, error)

CreateStandbyWorkspaces API operation for Amazon WorkSpaces.

Creates a standby WorkSpace in a secondary Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CreateStandbyWorkspaces for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceNotFoundException The resource could not be found.

  • ResourceLimitExceededException Your resource limits have been exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateStandbyWorkspaces

func (*WorkSpaces) CreateStandbyWorkspacesRequest added in v1.44.140 

func (c *WorkSpaces) CreateStandbyWorkspacesRequest(input *CreateStandbyWorkspacesInput) (req *request.Request, output *CreateStandbyWorkspacesOutput)

CreateStandbyWorkspacesRequest generates a "aws/request.Request" representing the client's request for the CreateStandbyWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateStandbyWorkspaces for more information on using the CreateStandbyWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateStandbyWorkspacesRequest method.
req, resp := client.CreateStandbyWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateStandbyWorkspaces

func (*WorkSpaces) CreateStandbyWorkspacesWithContext added in v1.44.140 

func (c *WorkSpaces) CreateStandbyWorkspacesWithContext(ctx aws.Context, input *CreateStandbyWorkspacesInput, opts ...request.Option) (*CreateStandbyWorkspacesOutput, error)

CreateStandbyWorkspacesWithContext is the same as CreateStandbyWorkspaces with the addition of the ability to pass a context and additional request options.

See CreateStandbyWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CreateTags added in v1.1.27 

func (c *WorkSpaces) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)

CreateTags API operation for Amazon WorkSpaces.

Creates the specified tags for the specified WorkSpaces resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CreateTags for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource could not be found.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceLimitExceededException Your resource limits have been exceeded.

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

func (*WorkSpaces) CreateTagsRequest added in v1.1.27 

func (c *WorkSpaces) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput)

CreateTagsRequest generates a "aws/request.Request" representing the client's request for the CreateTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTags for more information on using the CreateTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateTagsRequest method.
req, resp := client.CreateTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) CreateTagsWithContext added in v1.8.0 

func (c *WorkSpaces) CreateTagsWithContext(ctx aws.Context, input *CreateTagsInput, opts ...request.Option) (*CreateTagsOutput, error)

CreateTagsWithContext is the same as CreateTags with the addition of the ability to pass a context and additional request options.

See CreateTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CreateUpdatedWorkspaceImage added in v1.40.53 

func (c *WorkSpaces) CreateUpdatedWorkspaceImage(input *CreateUpdatedWorkspaceImageInput) (*CreateUpdatedWorkspaceImageOutput, error)

CreateUpdatedWorkspaceImage API operation for Amazon WorkSpaces.

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.

To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html).

  • Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.

  • Microsoft Windows updates and other application updates are not included in the update process.

  • The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CreateUpdatedWorkspaceImage for usage and error information.

Returned Error Types:

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceNotFoundException The resource could not be found.

  • OperationNotSupportedException This operation is not supported.

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

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateUpdatedWorkspaceImage

func (*WorkSpaces) CreateUpdatedWorkspaceImageRequest added in v1.40.53 

func (c *WorkSpaces) CreateUpdatedWorkspaceImageRequest(input *CreateUpdatedWorkspaceImageInput) (req *request.Request, output *CreateUpdatedWorkspaceImageOutput)

CreateUpdatedWorkspaceImageRequest generates a "aws/request.Request" representing the client's request for the CreateUpdatedWorkspaceImage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateUpdatedWorkspaceImage for more information on using the CreateUpdatedWorkspaceImage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateUpdatedWorkspaceImageRequest method.
req, resp := client.CreateUpdatedWorkspaceImageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateUpdatedWorkspaceImage

func (*WorkSpaces) CreateUpdatedWorkspaceImageWithContext added in v1.40.53 

func (c *WorkSpaces) CreateUpdatedWorkspaceImageWithContext(ctx aws.Context, input *CreateUpdatedWorkspaceImageInput, opts ...request.Option) (*CreateUpdatedWorkspaceImageOutput, error)

CreateUpdatedWorkspaceImageWithContext is the same as CreateUpdatedWorkspaceImage with the addition of the ability to pass a context and additional request options.

See CreateUpdatedWorkspaceImage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CreateWorkspaceBundle added in v1.37.30 

func (c *WorkSpaces) CreateWorkspaceBundle(input *CreateWorkspaceBundleInput) (*CreateWorkspaceBundleOutput, error)

CreateWorkspaceBundle API operation for Amazon WorkSpaces.

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle (https://docs.aws.amazon.com/workspaces/latest/adminguide/create-custom-bundle.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CreateWorkspaceBundle for usage and error information.

Returned Error Types:

  • ResourceUnavailableException The specified resource is not available.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceBundle

func (*WorkSpaces) CreateWorkspaceBundleRequest added in v1.37.30 

func (c *WorkSpaces) CreateWorkspaceBundleRequest(input *CreateWorkspaceBundleInput) (req *request.Request, output *CreateWorkspaceBundleOutput)

CreateWorkspaceBundleRequest generates a "aws/request.Request" representing the client's request for the CreateWorkspaceBundle operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkspaceBundle for more information on using the CreateWorkspaceBundle API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWorkspaceBundleRequest method.
req, resp := client.CreateWorkspaceBundleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceBundle

func (*WorkSpaces) CreateWorkspaceBundleWithContext added in v1.37.30 

func (c *WorkSpaces) CreateWorkspaceBundleWithContext(ctx aws.Context, input *CreateWorkspaceBundleInput, opts ...request.Option) (*CreateWorkspaceBundleOutput, error)

CreateWorkspaceBundleWithContext is the same as CreateWorkspaceBundle with the addition of the ability to pass a context and additional request options.

See CreateWorkspaceBundle for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CreateWorkspaceImage added in v1.44.64 

func (c *WorkSpaces) CreateWorkspaceImage(input *CreateWorkspaceImageInput) (*CreateWorkspaceImageOutput, error)

CreateWorkspaceImage API operation for Amazon WorkSpaces.

Creates a new WorkSpace image from an existing WorkSpace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CreateWorkspaceImage for usage and error information.

Returned Error Types:

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceNotFoundException The resource could not be found.

  • OperationNotSupportedException This operation is not supported.

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

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceImage

func (*WorkSpaces) CreateWorkspaceImageRequest added in v1.44.64 

func (c *WorkSpaces) CreateWorkspaceImageRequest(input *CreateWorkspaceImageInput) (req *request.Request, output *CreateWorkspaceImageOutput)

CreateWorkspaceImageRequest generates a "aws/request.Request" representing the client's request for the CreateWorkspaceImage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkspaceImage for more information on using the CreateWorkspaceImage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWorkspaceImageRequest method.
req, resp := client.CreateWorkspaceImageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceImage

func (*WorkSpaces) CreateWorkspaceImageWithContext added in v1.44.64 

func (c *WorkSpaces) CreateWorkspaceImageWithContext(ctx aws.Context, input *CreateWorkspaceImageInput, opts ...request.Option) (*CreateWorkspaceImageOutput, error)

CreateWorkspaceImageWithContext is the same as CreateWorkspaceImage with the addition of the ability to pass a context and additional request options.

See CreateWorkspaceImage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) CreateWorkspaces 

func (c *WorkSpaces) CreateWorkspaces(input *CreateWorkspacesInput) (*CreateWorkspacesOutput, error)

CreateWorkspaces API operation for Amazon WorkSpaces.

Creates one or more WorkSpaces.

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

  • The MANUAL running mode 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 (http://aws.amazon.com/workspaces/core/).

  • You don't need to specify the PCOIP protocol for Linux bundles because WSP is the default protocol for those bundles.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation CreateWorkspaces for usage and error information.

Returned Error Types:

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • InvalidParameterValuesException One or more parameter values are not valid.

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

func (*WorkSpaces) CreateWorkspacesRequest 

func (c *WorkSpaces) CreateWorkspacesRequest(input *CreateWorkspacesInput) (req *request.Request, output *CreateWorkspacesOutput)

CreateWorkspacesRequest generates a "aws/request.Request" representing the client's request for the CreateWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkspaces for more information on using the CreateWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWorkspacesRequest method.
req, resp := client.CreateWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) CreateWorkspacesWithContext added in v1.8.0 

func (c *WorkSpaces) CreateWorkspacesWithContext(ctx aws.Context, input *CreateWorkspacesInput, opts ...request.Option) (*CreateWorkspacesOutput, error)

CreateWorkspacesWithContext is the same as CreateWorkspaces with the addition of the ability to pass a context and additional request options.

See CreateWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DeleteClientBranding added in v1.43.30 

func (c *WorkSpaces) DeleteClientBranding(input *DeleteClientBrandingInput) (*DeleteClientBrandingOutput, error)

DeleteClientBranding API operation for Amazon WorkSpaces.

Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you delete your customized client branding, your login portal reverts to the default client branding.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DeleteClientBranding for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteClientBranding

func (*WorkSpaces) DeleteClientBrandingRequest added in v1.43.30 

func (c *WorkSpaces) DeleteClientBrandingRequest(input *DeleteClientBrandingInput) (req *request.Request, output *DeleteClientBrandingOutput)

DeleteClientBrandingRequest generates a "aws/request.Request" representing the client's request for the DeleteClientBranding operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteClientBranding for more information on using the DeleteClientBranding API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteClientBrandingRequest method.
req, resp := client.DeleteClientBrandingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteClientBranding

func (*WorkSpaces) DeleteClientBrandingWithContext added in v1.43.30 

func (c *WorkSpaces) DeleteClientBrandingWithContext(ctx aws.Context, input *DeleteClientBrandingInput, opts ...request.Option) (*DeleteClientBrandingOutput, error)

DeleteClientBrandingWithContext is the same as DeleteClientBranding with the addition of the ability to pass a context and additional request options.

See DeleteClientBranding for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DeleteConnectClientAddIn added in v1.42.32 

func (c *WorkSpaces) DeleteConnectClientAddIn(input *DeleteConnectClientAddInInput) (*DeleteConnectClientAddInOutput, error)

DeleteConnectClientAddIn API operation for Amazon WorkSpaces.

Deletes a client-add-in for Amazon Connect that is configured within a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DeleteConnectClientAddIn for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteConnectClientAddIn

func (*WorkSpaces) DeleteConnectClientAddInRequest added in v1.42.32 

func (c *WorkSpaces) DeleteConnectClientAddInRequest(input *DeleteConnectClientAddInInput) (req *request.Request, output *DeleteConnectClientAddInOutput)

DeleteConnectClientAddInRequest generates a "aws/request.Request" representing the client's request for the DeleteConnectClientAddIn operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConnectClientAddIn for more information on using the DeleteConnectClientAddIn API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteConnectClientAddInRequest method.
req, resp := client.DeleteConnectClientAddInRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteConnectClientAddIn

func (*WorkSpaces) DeleteConnectClientAddInWithContext added in v1.42.32 

func (c *WorkSpaces) DeleteConnectClientAddInWithContext(ctx aws.Context, input *DeleteConnectClientAddInInput, opts ...request.Option) (*DeleteConnectClientAddInOutput, error)

DeleteConnectClientAddInWithContext is the same as DeleteConnectClientAddIn with the addition of the ability to pass a context and additional request options.

See DeleteConnectClientAddIn for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DeleteConnectionAlias added in v1.34.22 

func (c *WorkSpaces) DeleteConnectionAlias(input *DeleteConnectionAliasInput) (*DeleteConnectionAliasOutput, error)

DeleteConnectionAlias API operation for Amazon WorkSpaces.

Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations).

To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DeleteConnectionAlias for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource could not be found.

  • ResourceAssociatedException The resource is associated with a directory.

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

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

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteConnectionAlias

func (*WorkSpaces) DeleteConnectionAliasRequest added in v1.34.22 

func (c *WorkSpaces) DeleteConnectionAliasRequest(input *DeleteConnectionAliasInput) (req *request.Request, output *DeleteConnectionAliasOutput)

DeleteConnectionAliasRequest generates a "aws/request.Request" representing the client's request for the DeleteConnectionAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteConnectionAlias for more information on using the DeleteConnectionAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteConnectionAliasRequest method.
req, resp := client.DeleteConnectionAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteConnectionAlias

func (*WorkSpaces) DeleteConnectionAliasWithContext added in v1.34.22 

func (c *WorkSpaces) DeleteConnectionAliasWithContext(ctx aws.Context, input *DeleteConnectionAliasInput, opts ...request.Option) (*DeleteConnectionAliasOutput, error)

DeleteConnectionAliasWithContext is the same as DeleteConnectionAlias with the addition of the ability to pass a context and additional request options.

See DeleteConnectionAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DeleteIpGroup added in v1.13.39 

func (c *WorkSpaces) DeleteIpGroup(input *DeleteIpGroupInput) (*DeleteIpGroupOutput, error)

DeleteIpGroup API operation for Amazon WorkSpaces.

Deletes the specified IP access control group.

You cannot delete an IP access control group that is associated with a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DeleteIpGroup for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • ResourceAssociatedException The resource is associated with a directory.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteIpGroup

func (*WorkSpaces) DeleteIpGroupRequest added in v1.13.39 

func (c *WorkSpaces) DeleteIpGroupRequest(input *DeleteIpGroupInput) (req *request.Request, output *DeleteIpGroupOutput)

DeleteIpGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteIpGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteIpGroup for more information on using the DeleteIpGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteIpGroupRequest method.
req, resp := client.DeleteIpGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteIpGroup

func (*WorkSpaces) DeleteIpGroupWithContext added in v1.13.39 

func (c *WorkSpaces) DeleteIpGroupWithContext(ctx aws.Context, input *DeleteIpGroupInput, opts ...request.Option) (*DeleteIpGroupOutput, error)

DeleteIpGroupWithContext is the same as DeleteIpGroup with the addition of the ability to pass a context and additional request options.

See DeleteIpGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DeleteTags added in v1.1.27 

func (c *WorkSpaces) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)

DeleteTags API operation for Amazon WorkSpaces.

Deletes the specified tags from the specified WorkSpaces resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DeleteTags for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource could not be found.

  • InvalidParameterValuesException One or more parameter values are not valid.

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

func (*WorkSpaces) DeleteTagsRequest added in v1.1.27 

func (c *WorkSpaces) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)

DeleteTagsRequest generates a "aws/request.Request" representing the client's request for the DeleteTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTags for more information on using the DeleteTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteTagsRequest method.
req, resp := client.DeleteTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) DeleteTagsWithContext added in v1.8.0 

func (c *WorkSpaces) DeleteTagsWithContext(ctx aws.Context, input *DeleteTagsInput, opts ...request.Option) (*DeleteTagsOutput, error)

DeleteTagsWithContext is the same as DeleteTags with the addition of the ability to pass a context and additional request options.

See DeleteTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DeleteWorkspaceBundle added in v1.37.30 

func (c *WorkSpaces) DeleteWorkspaceBundle(input *DeleteWorkspaceBundleInput) (*DeleteWorkspaceBundleOutput, error)

DeleteWorkspaceBundle API operation for Amazon WorkSpaces.

Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete_bundle.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DeleteWorkspaceBundle for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • ResourceAssociatedException The resource is associated with a directory.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteWorkspaceBundle

func (*WorkSpaces) DeleteWorkspaceBundleRequest added in v1.37.30 

func (c *WorkSpaces) DeleteWorkspaceBundleRequest(input *DeleteWorkspaceBundleInput) (req *request.Request, output *DeleteWorkspaceBundleOutput)

DeleteWorkspaceBundleRequest generates a "aws/request.Request" representing the client's request for the DeleteWorkspaceBundle operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWorkspaceBundle for more information on using the DeleteWorkspaceBundle API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWorkspaceBundleRequest method.
req, resp := client.DeleteWorkspaceBundleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteWorkspaceBundle

func (*WorkSpaces) DeleteWorkspaceBundleWithContext added in v1.37.30 

func (c *WorkSpaces) DeleteWorkspaceBundleWithContext(ctx aws.Context, input *DeleteWorkspaceBundleInput, opts ...request.Option) (*DeleteWorkspaceBundleOutput, error)

DeleteWorkspaceBundleWithContext is the same as DeleteWorkspaceBundle with the addition of the ability to pass a context and additional request options.

See DeleteWorkspaceBundle for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DeleteWorkspaceImage added in v1.15.78 

func (c *WorkSpaces) DeleteWorkspaceImage(input *DeleteWorkspaceImageInput) (*DeleteWorkspaceImageOutput, error)

DeleteWorkspaceImage API operation for Amazon WorkSpaces.

Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DeleteWorkspaceImage for usage and error information.

Returned Error Types:

  • ResourceAssociatedException The resource is associated with a directory.

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

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteWorkspaceImage

func (*WorkSpaces) DeleteWorkspaceImageRequest added in v1.15.78 

func (c *WorkSpaces) DeleteWorkspaceImageRequest(input *DeleteWorkspaceImageInput) (req *request.Request, output *DeleteWorkspaceImageOutput)

DeleteWorkspaceImageRequest generates a "aws/request.Request" representing the client's request for the DeleteWorkspaceImage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWorkspaceImage for more information on using the DeleteWorkspaceImage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWorkspaceImageRequest method.
req, resp := client.DeleteWorkspaceImageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteWorkspaceImage

func (*WorkSpaces) DeleteWorkspaceImageWithContext added in v1.15.78 

func (c *WorkSpaces) DeleteWorkspaceImageWithContext(ctx aws.Context, input *DeleteWorkspaceImageInput, opts ...request.Option) (*DeleteWorkspaceImageOutput, error)

DeleteWorkspaceImageWithContext is the same as DeleteWorkspaceImage with the addition of the ability to pass a context and additional request options.

See DeleteWorkspaceImage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DeployWorkspaceApplications added in v1.45.23 

func (c *WorkSpaces) DeployWorkspaceApplications(input *DeployWorkspaceApplicationsInput) (*DeployWorkspaceApplicationsOutput, error)

DeployWorkspaceApplications API operation for Amazon WorkSpaces.

Deploys associated applications to the specified WorkSpace

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DeployWorkspaceApplications for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceInUseException The specified resource is currently in use.

  • ResourceNotFoundException The resource could not be found.

  • IncompatibleApplicationsException The specified application is not compatible with the resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeployWorkspaceApplications

func (*WorkSpaces) DeployWorkspaceApplicationsRequest added in v1.45.23 

func (c *WorkSpaces) DeployWorkspaceApplicationsRequest(input *DeployWorkspaceApplicationsInput) (req *request.Request, output *DeployWorkspaceApplicationsOutput)

DeployWorkspaceApplicationsRequest generates a "aws/request.Request" representing the client's request for the DeployWorkspaceApplications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeployWorkspaceApplications for more information on using the DeployWorkspaceApplications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeployWorkspaceApplicationsRequest method.
req, resp := client.DeployWorkspaceApplicationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeployWorkspaceApplications

func (*WorkSpaces) DeployWorkspaceApplicationsWithContext added in v1.45.23 

func (c *WorkSpaces) DeployWorkspaceApplicationsWithContext(ctx aws.Context, input *DeployWorkspaceApplicationsInput, opts ...request.Option) (*DeployWorkspaceApplicationsOutput, error)

DeployWorkspaceApplicationsWithContext is the same as DeployWorkspaceApplications with the addition of the ability to pass a context and additional request options.

See DeployWorkspaceApplications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DeregisterWorkspaceDirectory added in v1.25.36 

func (c *WorkSpaces) DeregisterWorkspaceDirectory(input *DeregisterWorkspaceDirectoryInput) (*DeregisterWorkspaceDirectoryOutput, error)

DeregisterWorkspaceDirectory API operation for Amazon WorkSpaces.

Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.

Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms (http://aws.amazon.com/directoryservice/pricing/).

To delete empty directories, see Delete the Directory for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DeregisterWorkspaceDirectory for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceNotFoundException The resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeregisterWorkspaceDirectory

func (*WorkSpaces) DeregisterWorkspaceDirectoryRequest added in v1.25.36 

func (c *WorkSpaces) DeregisterWorkspaceDirectoryRequest(input *DeregisterWorkspaceDirectoryInput) (req *request.Request, output *DeregisterWorkspaceDirectoryOutput)

DeregisterWorkspaceDirectoryRequest generates a "aws/request.Request" representing the client's request for the DeregisterWorkspaceDirectory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterWorkspaceDirectory for more information on using the DeregisterWorkspaceDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeregisterWorkspaceDirectoryRequest method.
req, resp := client.DeregisterWorkspaceDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeregisterWorkspaceDirectory

func (*WorkSpaces) DeregisterWorkspaceDirectoryWithContext added in v1.25.36 

func (c *WorkSpaces) DeregisterWorkspaceDirectoryWithContext(ctx aws.Context, input *DeregisterWorkspaceDirectoryInput, opts ...request.Option) (*DeregisterWorkspaceDirectoryOutput, error)

DeregisterWorkspaceDirectoryWithContext is the same as DeregisterWorkspaceDirectory with the addition of the ability to pass a context and additional request options.

See DeregisterWorkspaceDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeAccount added in v1.15.78 

func (c *WorkSpaces) DescribeAccount(input *DescribeAccountInput) (*DescribeAccountOutput, error)

DescribeAccount API operation for Amazon WorkSpaces.

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeAccount for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeAccount

func (*WorkSpaces) DescribeAccountModifications added in v1.15.78 

func (c *WorkSpaces) DescribeAccountModifications(input *DescribeAccountModificationsInput) (*DescribeAccountModificationsOutput, error)

DescribeAccountModifications API operation for Amazon WorkSpaces.

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeAccountModifications for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeAccountModifications

func (*WorkSpaces) DescribeAccountModificationsRequest added in v1.15.78 

func (c *WorkSpaces) DescribeAccountModificationsRequest(input *DescribeAccountModificationsInput) (req *request.Request, output *DescribeAccountModificationsOutput)

DescribeAccountModificationsRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountModifications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccountModifications for more information on using the DescribeAccountModifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAccountModificationsRequest method.
req, resp := client.DescribeAccountModificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeAccountModifications

func (*WorkSpaces) DescribeAccountModificationsWithContext added in v1.15.78 

func (c *WorkSpaces) DescribeAccountModificationsWithContext(ctx aws.Context, input *DescribeAccountModificationsInput, opts ...request.Option) (*DescribeAccountModificationsOutput, error)

DescribeAccountModificationsWithContext is the same as DescribeAccountModifications with the addition of the ability to pass a context and additional request options.

See DescribeAccountModifications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeAccountRequest added in v1.15.78 

func (c *WorkSpaces) DescribeAccountRequest(input *DescribeAccountInput) (req *request.Request, output *DescribeAccountOutput)

DescribeAccountRequest generates a "aws/request.Request" representing the client's request for the DescribeAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccount for more information on using the DescribeAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAccountRequest method.
req, resp := client.DescribeAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeAccount

func (*WorkSpaces) DescribeAccountWithContext added in v1.15.78 

func (c *WorkSpaces) DescribeAccountWithContext(ctx aws.Context, input *DescribeAccountInput, opts ...request.Option) (*DescribeAccountOutput, error)

DescribeAccountWithContext is the same as DescribeAccount with the addition of the ability to pass a context and additional request options.

See DescribeAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeApplicationAssociations added in v1.45.23 

func (c *WorkSpaces) DescribeApplicationAssociations(input *DescribeApplicationAssociationsInput) (*DescribeApplicationAssociationsOutput, error)

DescribeApplicationAssociations API operation for Amazon WorkSpaces.

Describes the associations between the application and the specified associated resources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeApplicationAssociations for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeApplicationAssociations

func (*WorkSpaces) DescribeApplicationAssociationsPages added in v1.45.23 

func (c *WorkSpaces) DescribeApplicationAssociationsPages(input *DescribeApplicationAssociationsInput, fn func(*DescribeApplicationAssociationsOutput, bool) bool) error

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

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

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

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

func (*WorkSpaces) DescribeApplicationAssociationsPagesWithContext added in v1.45.23 

func (c *WorkSpaces) DescribeApplicationAssociationsPagesWithContext(ctx aws.Context, input *DescribeApplicationAssociationsInput, fn func(*DescribeApplicationAssociationsOutput, bool) bool, opts ...request.Option) error

DescribeApplicationAssociationsPagesWithContext same as DescribeApplicationAssociationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeApplicationAssociationsRequest added in v1.45.23 

func (c *WorkSpaces) DescribeApplicationAssociationsRequest(input *DescribeApplicationAssociationsInput) (req *request.Request, output *DescribeApplicationAssociationsOutput)

DescribeApplicationAssociationsRequest generates a "aws/request.Request" representing the client's request for the DescribeApplicationAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeApplicationAssociations for more information on using the DescribeApplicationAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeApplicationAssociationsRequest method.
req, resp := client.DescribeApplicationAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeApplicationAssociations

func (*WorkSpaces) DescribeApplicationAssociationsWithContext added in v1.45.23 

func (c *WorkSpaces) DescribeApplicationAssociationsWithContext(ctx aws.Context, input *DescribeApplicationAssociationsInput, opts ...request.Option) (*DescribeApplicationAssociationsOutput, error)

DescribeApplicationAssociationsWithContext is the same as DescribeApplicationAssociations with the addition of the ability to pass a context and additional request options.

See DescribeApplicationAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeApplications added in v1.45.23 

func (c *WorkSpaces) DescribeApplications(input *DescribeApplicationsInput) (*DescribeApplicationsOutput, error)

DescribeApplications API operation for Amazon WorkSpaces.

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeApplications for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeApplications

func (*WorkSpaces) DescribeApplicationsPages added in v1.45.23 

func (c *WorkSpaces) DescribeApplicationsPages(input *DescribeApplicationsInput, fn func(*DescribeApplicationsOutput, bool) bool) error

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

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

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

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

func (*WorkSpaces) DescribeApplicationsPagesWithContext added in v1.45.23 

func (c *WorkSpaces) DescribeApplicationsPagesWithContext(ctx aws.Context, input *DescribeApplicationsInput, fn func(*DescribeApplicationsOutput, bool) bool, opts ...request.Option) error

DescribeApplicationsPagesWithContext same as DescribeApplicationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeApplicationsRequest added in v1.45.23 

func (c *WorkSpaces) DescribeApplicationsRequest(input *DescribeApplicationsInput) (req *request.Request, output *DescribeApplicationsOutput)

DescribeApplicationsRequest generates a "aws/request.Request" representing the client's request for the DescribeApplications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeApplications for more information on using the DescribeApplications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeApplicationsRequest method.
req, resp := client.DescribeApplicationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeApplications

func (*WorkSpaces) DescribeApplicationsWithContext added in v1.45.23 

func (c *WorkSpaces) DescribeApplicationsWithContext(ctx aws.Context, input *DescribeApplicationsInput, opts ...request.Option) (*DescribeApplicationsOutput, error)

DescribeApplicationsWithContext is the same as DescribeApplications with the addition of the ability to pass a context and additional request options.

See DescribeApplications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeBundleAssociations added in v1.45.23 

func (c *WorkSpaces) DescribeBundleAssociations(input *DescribeBundleAssociationsInput) (*DescribeBundleAssociationsOutput, error)

DescribeBundleAssociations API operation for Amazon WorkSpaces.

Describes the associations between the applications and the specified bundle.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeBundleAssociations for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeBundleAssociations

func (*WorkSpaces) DescribeBundleAssociationsRequest added in v1.45.23 

func (c *WorkSpaces) DescribeBundleAssociationsRequest(input *DescribeBundleAssociationsInput) (req *request.Request, output *DescribeBundleAssociationsOutput)

DescribeBundleAssociationsRequest generates a "aws/request.Request" representing the client's request for the DescribeBundleAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBundleAssociations for more information on using the DescribeBundleAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBundleAssociationsRequest method.
req, resp := client.DescribeBundleAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeBundleAssociations

func (*WorkSpaces) DescribeBundleAssociationsWithContext added in v1.45.23 

func (c *WorkSpaces) DescribeBundleAssociationsWithContext(ctx aws.Context, input *DescribeBundleAssociationsInput, opts ...request.Option) (*DescribeBundleAssociationsOutput, error)

DescribeBundleAssociationsWithContext is the same as DescribeBundleAssociations with the addition of the ability to pass a context and additional request options.

See DescribeBundleAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeClientBranding added in v1.43.30 

func (c *WorkSpaces) DescribeClientBranding(input *DescribeClientBrandingInput) (*DescribeClientBrandingOutput, error)

DescribeClientBranding API operation for Amazon WorkSpaces.

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

Only device types that have branding information configured will be shown in the response.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeClientBranding for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientBranding

func (*WorkSpaces) DescribeClientBrandingRequest added in v1.43.30 

func (c *WorkSpaces) DescribeClientBrandingRequest(input *DescribeClientBrandingInput) (req *request.Request, output *DescribeClientBrandingOutput)

DescribeClientBrandingRequest generates a "aws/request.Request" representing the client's request for the DescribeClientBranding operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeClientBranding for more information on using the DescribeClientBranding API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeClientBrandingRequest method.
req, resp := client.DescribeClientBrandingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientBranding

func (*WorkSpaces) DescribeClientBrandingWithContext added in v1.43.30 

func (c *WorkSpaces) DescribeClientBrandingWithContext(ctx aws.Context, input *DescribeClientBrandingInput, opts ...request.Option) (*DescribeClientBrandingOutput, error)

DescribeClientBrandingWithContext is the same as DescribeClientBranding with the addition of the ability to pass a context and additional request options.

See DescribeClientBranding for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeClientProperties added in v1.15.79 

func (c *WorkSpaces) DescribeClientProperties(input *DescribeClientPropertiesInput) (*DescribeClientPropertiesOutput, error)

DescribeClientProperties API operation for Amazon WorkSpaces.

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeClientProperties for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientProperties

func (*WorkSpaces) DescribeClientPropertiesRequest added in v1.15.79 

func (c *WorkSpaces) DescribeClientPropertiesRequest(input *DescribeClientPropertiesInput) (req *request.Request, output *DescribeClientPropertiesOutput)

DescribeClientPropertiesRequest generates a "aws/request.Request" representing the client's request for the DescribeClientProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeClientProperties for more information on using the DescribeClientProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeClientPropertiesRequest method.
req, resp := client.DescribeClientPropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientProperties

func (*WorkSpaces) DescribeClientPropertiesWithContext added in v1.15.79 

func (c *WorkSpaces) DescribeClientPropertiesWithContext(ctx aws.Context, input *DescribeClientPropertiesInput, opts ...request.Option) (*DescribeClientPropertiesOutput, error)

DescribeClientPropertiesWithContext is the same as DescribeClientProperties with the addition of the ability to pass a context and additional request options.

See DescribeClientProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeConnectClientAddIns added in v1.42.32 

func (c *WorkSpaces) DescribeConnectClientAddIns(input *DescribeConnectClientAddInsInput) (*DescribeConnectClientAddInsOutput, error)

DescribeConnectClientAddIns API operation for Amazon WorkSpaces.

Retrieves a list of Amazon Connect client add-ins that have been created.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeConnectClientAddIns for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectClientAddIns

func (*WorkSpaces) DescribeConnectClientAddInsRequest added in v1.42.32 

func (c *WorkSpaces) DescribeConnectClientAddInsRequest(input *DescribeConnectClientAddInsInput) (req *request.Request, output *DescribeConnectClientAddInsOutput)

DescribeConnectClientAddInsRequest generates a "aws/request.Request" representing the client's request for the DescribeConnectClientAddIns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeConnectClientAddIns for more information on using the DescribeConnectClientAddIns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeConnectClientAddInsRequest method.
req, resp := client.DescribeConnectClientAddInsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectClientAddIns

func (*WorkSpaces) DescribeConnectClientAddInsWithContext added in v1.42.32 

func (c *WorkSpaces) DescribeConnectClientAddInsWithContext(ctx aws.Context, input *DescribeConnectClientAddInsInput, opts ...request.Option) (*DescribeConnectClientAddInsOutput, error)

DescribeConnectClientAddInsWithContext is the same as DescribeConnectClientAddIns with the addition of the ability to pass a context and additional request options.

See DescribeConnectClientAddIns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeConnectionAliasPermissions added in v1.34.22 

func (c *WorkSpaces) DescribeConnectionAliasPermissions(input *DescribeConnectionAliasPermissionsInput) (*DescribeConnectionAliasPermissionsOutput, error)

DescribeConnectionAliasPermissions API operation for Amazon WorkSpaces.

Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeConnectionAliasPermissions for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissions

func (*WorkSpaces) DescribeConnectionAliasPermissionsRequest added in v1.34.22 

func (c *WorkSpaces) DescribeConnectionAliasPermissionsRequest(input *DescribeConnectionAliasPermissionsInput) (req *request.Request, output *DescribeConnectionAliasPermissionsOutput)

DescribeConnectionAliasPermissionsRequest generates a "aws/request.Request" representing the client's request for the DescribeConnectionAliasPermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeConnectionAliasPermissions for more information on using the DescribeConnectionAliasPermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeConnectionAliasPermissionsRequest method.
req, resp := client.DescribeConnectionAliasPermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissions

func (*WorkSpaces) DescribeConnectionAliasPermissionsWithContext added in v1.34.22 

func (c *WorkSpaces) DescribeConnectionAliasPermissionsWithContext(ctx aws.Context, input *DescribeConnectionAliasPermissionsInput, opts ...request.Option) (*DescribeConnectionAliasPermissionsOutput, error)

DescribeConnectionAliasPermissionsWithContext is the same as DescribeConnectionAliasPermissions with the addition of the ability to pass a context and additional request options.

See DescribeConnectionAliasPermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeConnectionAliases added in v1.34.22 

func (c *WorkSpaces) DescribeConnectionAliases(input *DescribeConnectionAliasesInput) (*DescribeConnectionAliasesOutput, error)

DescribeConnectionAliases API operation for Amazon WorkSpaces.

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeConnectionAliases for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliases

func (*WorkSpaces) DescribeConnectionAliasesRequest added in v1.34.22 

func (c *WorkSpaces) DescribeConnectionAliasesRequest(input *DescribeConnectionAliasesInput) (req *request.Request, output *DescribeConnectionAliasesOutput)

DescribeConnectionAliasesRequest generates a "aws/request.Request" representing the client's request for the DescribeConnectionAliases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeConnectionAliases for more information on using the DescribeConnectionAliases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeConnectionAliasesRequest method.
req, resp := client.DescribeConnectionAliasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliases

func (*WorkSpaces) DescribeConnectionAliasesWithContext added in v1.34.22 

func (c *WorkSpaces) DescribeConnectionAliasesWithContext(ctx aws.Context, input *DescribeConnectionAliasesInput, opts ...request.Option) (*DescribeConnectionAliasesOutput, error)

DescribeConnectionAliasesWithContext is the same as DescribeConnectionAliases with the addition of the ability to pass a context and additional request options.

See DescribeConnectionAliases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeImageAssociations added in v1.45.23 

func (c *WorkSpaces) DescribeImageAssociations(input *DescribeImageAssociationsInput) (*DescribeImageAssociationsOutput, error)

DescribeImageAssociations API operation for Amazon WorkSpaces.

Describes the associations between the applications and the specified image.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeImageAssociations for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeImageAssociations

func (*WorkSpaces) DescribeImageAssociationsRequest added in v1.45.23 

func (c *WorkSpaces) DescribeImageAssociationsRequest(input *DescribeImageAssociationsInput) (req *request.Request, output *DescribeImageAssociationsOutput)

DescribeImageAssociationsRequest generates a "aws/request.Request" representing the client's request for the DescribeImageAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeImageAssociations for more information on using the DescribeImageAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeImageAssociationsRequest method.
req, resp := client.DescribeImageAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeImageAssociations

func (*WorkSpaces) DescribeImageAssociationsWithContext added in v1.45.23 

func (c *WorkSpaces) DescribeImageAssociationsWithContext(ctx aws.Context, input *DescribeImageAssociationsInput, opts ...request.Option) (*DescribeImageAssociationsOutput, error)

DescribeImageAssociationsWithContext is the same as DescribeImageAssociations with the addition of the ability to pass a context and additional request options.

See DescribeImageAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeIpGroups added in v1.13.39 

func (c *WorkSpaces) DescribeIpGroups(input *DescribeIpGroupsInput) (*DescribeIpGroupsOutput, error)

DescribeIpGroups API operation for Amazon WorkSpaces.

Describes one or more of your IP access control groups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeIpGroups for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeIpGroups

func (*WorkSpaces) DescribeIpGroupsRequest added in v1.13.39 

func (c *WorkSpaces) DescribeIpGroupsRequest(input *DescribeIpGroupsInput) (req *request.Request, output *DescribeIpGroupsOutput)

DescribeIpGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeIpGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeIpGroups for more information on using the DescribeIpGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeIpGroupsRequest method.
req, resp := client.DescribeIpGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeIpGroups

func (*WorkSpaces) DescribeIpGroupsWithContext added in v1.13.39 

func (c *WorkSpaces) DescribeIpGroupsWithContext(ctx aws.Context, input *DescribeIpGroupsInput, opts ...request.Option) (*DescribeIpGroupsOutput, error)

DescribeIpGroupsWithContext is the same as DescribeIpGroups with the addition of the ability to pass a context and additional request options.

See DescribeIpGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeTags added in v1.1.27 

func (c *WorkSpaces) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)

DescribeTags API operation for Amazon WorkSpaces.

Describes the specified tags for the specified WorkSpaces resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeTags for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource could not be found.

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

func (*WorkSpaces) DescribeTagsRequest added in v1.1.27 

func (c *WorkSpaces) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)

DescribeTagsRequest generates a "aws/request.Request" representing the client's request for the DescribeTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTags for more information on using the DescribeTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTagsRequest method.
req, resp := client.DescribeTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) DescribeTagsWithContext added in v1.8.0 

func (c *WorkSpaces) DescribeTagsWithContext(ctx aws.Context, input *DescribeTagsInput, opts ...request.Option) (*DescribeTagsOutput, error)

DescribeTagsWithContext is the same as DescribeTags with the addition of the ability to pass a context and additional request options.

See DescribeTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspaceAssociations added in v1.45.23 

func (c *WorkSpaces) DescribeWorkspaceAssociations(input *DescribeWorkspaceAssociationsInput) (*DescribeWorkspaceAssociationsOutput, error)

DescribeWorkspaceAssociations API operation for Amazon WorkSpaces.

Describes the associations betweens applications and the specified WorkSpace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeWorkspaceAssociations for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceAssociations

func (*WorkSpaces) DescribeWorkspaceAssociationsRequest added in v1.45.23 

func (c *WorkSpaces) DescribeWorkspaceAssociationsRequest(input *DescribeWorkspaceAssociationsInput) (req *request.Request, output *DescribeWorkspaceAssociationsOutput)

DescribeWorkspaceAssociationsRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceAssociations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspaceAssociations for more information on using the DescribeWorkspaceAssociations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspaceAssociationsRequest method.
req, resp := client.DescribeWorkspaceAssociationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceAssociations

func (*WorkSpaces) DescribeWorkspaceAssociationsWithContext added in v1.45.23 

func (c *WorkSpaces) DescribeWorkspaceAssociationsWithContext(ctx aws.Context, input *DescribeWorkspaceAssociationsInput, opts ...request.Option) (*DescribeWorkspaceAssociationsOutput, error)

DescribeWorkspaceAssociationsWithContext is the same as DescribeWorkspaceAssociations with the addition of the ability to pass a context and additional request options.

See DescribeWorkspaceAssociations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspaceBundles 

func (c *WorkSpaces) DescribeWorkspaceBundles(input *DescribeWorkspaceBundlesInput) (*DescribeWorkspaceBundlesOutput, error)

DescribeWorkspaceBundles API operation for Amazon WorkSpaces.

Retrieves a list that describes the available WorkSpace bundles.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeWorkspaceBundles for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

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

func (*WorkSpaces) DescribeWorkspaceBundlesPages added in v0.6.5 

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

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

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

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

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

func (*WorkSpaces) DescribeWorkspaceBundlesPagesWithContext added in v1.8.0 

func (c *WorkSpaces) DescribeWorkspaceBundlesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, fn func(*DescribeWorkspaceBundlesOutput, bool) bool, opts ...request.Option) error

DescribeWorkspaceBundlesPagesWithContext same as DescribeWorkspaceBundlesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspaceBundlesRequest 

func (c *WorkSpaces) DescribeWorkspaceBundlesRequest(input *DescribeWorkspaceBundlesInput) (req *request.Request, output *DescribeWorkspaceBundlesOutput)

DescribeWorkspaceBundlesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceBundles operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspaceBundles for more information on using the DescribeWorkspaceBundles API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspaceBundlesRequest method.
req, resp := client.DescribeWorkspaceBundlesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) DescribeWorkspaceBundlesWithContext added in v1.8.0 

func (c *WorkSpaces) DescribeWorkspaceBundlesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, opts ...request.Option) (*DescribeWorkspaceBundlesOutput, error)

DescribeWorkspaceBundlesWithContext is the same as DescribeWorkspaceBundles with the addition of the ability to pass a context and additional request options.

See DescribeWorkspaceBundles for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspaceDirectories 

func (c *WorkSpaces) DescribeWorkspaceDirectories(input *DescribeWorkspaceDirectoriesInput) (*DescribeWorkspaceDirectoriesOutput, error)

DescribeWorkspaceDirectories API operation for Amazon WorkSpaces.

Describes the available directories that are registered with Amazon WorkSpaces.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeWorkspaceDirectories for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

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

func (*WorkSpaces) DescribeWorkspaceDirectoriesPages added in v0.6.5 

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

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

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

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

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

func (*WorkSpaces) DescribeWorkspaceDirectoriesPagesWithContext added in v1.8.0 

func (c *WorkSpaces) DescribeWorkspaceDirectoriesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, fn func(*DescribeWorkspaceDirectoriesOutput, bool) bool, opts ...request.Option) error

DescribeWorkspaceDirectoriesPagesWithContext same as DescribeWorkspaceDirectoriesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspaceDirectoriesRequest 

func (c *WorkSpaces) DescribeWorkspaceDirectoriesRequest(input *DescribeWorkspaceDirectoriesInput) (req *request.Request, output *DescribeWorkspaceDirectoriesOutput)

DescribeWorkspaceDirectoriesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceDirectories operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspaceDirectories for more information on using the DescribeWorkspaceDirectories API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspaceDirectoriesRequest method.
req, resp := client.DescribeWorkspaceDirectoriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) DescribeWorkspaceDirectoriesWithContext added in v1.8.0 

func (c *WorkSpaces) DescribeWorkspaceDirectoriesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, opts ...request.Option) (*DescribeWorkspaceDirectoriesOutput, error)

DescribeWorkspaceDirectoriesWithContext is the same as DescribeWorkspaceDirectories with the addition of the ability to pass a context and additional request options.

See DescribeWorkspaceDirectories for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspaceImagePermissions added in v1.33.11 

func (c *WorkSpaces) DescribeWorkspaceImagePermissions(input *DescribeWorkspaceImagePermissionsInput) (*DescribeWorkspaceImagePermissionsOutput, error)

DescribeWorkspaceImagePermissions API operation for Amazon WorkSpaces.

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeWorkspaceImagePermissions for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissions

func (*WorkSpaces) DescribeWorkspaceImagePermissionsRequest added in v1.33.11 

func (c *WorkSpaces) DescribeWorkspaceImagePermissionsRequest(input *DescribeWorkspaceImagePermissionsInput) (req *request.Request, output *DescribeWorkspaceImagePermissionsOutput)

DescribeWorkspaceImagePermissionsRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceImagePermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspaceImagePermissions for more information on using the DescribeWorkspaceImagePermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspaceImagePermissionsRequest method.
req, resp := client.DescribeWorkspaceImagePermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissions

func (*WorkSpaces) DescribeWorkspaceImagePermissionsWithContext added in v1.33.11 

func (c *WorkSpaces) DescribeWorkspaceImagePermissionsWithContext(ctx aws.Context, input *DescribeWorkspaceImagePermissionsInput, opts ...request.Option) (*DescribeWorkspaceImagePermissionsOutput, error)

DescribeWorkspaceImagePermissionsWithContext is the same as DescribeWorkspaceImagePermissions with the addition of the ability to pass a context and additional request options.

See DescribeWorkspaceImagePermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspaceImages added in v1.15.78 

func (c *WorkSpaces) DescribeWorkspaceImages(input *DescribeWorkspaceImagesInput) (*DescribeWorkspaceImagesOutput, error)

DescribeWorkspaceImages API operation for Amazon WorkSpaces.

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeWorkspaceImages for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImages

func (*WorkSpaces) DescribeWorkspaceImagesRequest added in v1.15.78 

func (c *WorkSpaces) DescribeWorkspaceImagesRequest(input *DescribeWorkspaceImagesInput) (req *request.Request, output *DescribeWorkspaceImagesOutput)

DescribeWorkspaceImagesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceImages operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspaceImages for more information on using the DescribeWorkspaceImages API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspaceImagesRequest method.
req, resp := client.DescribeWorkspaceImagesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImages

func (*WorkSpaces) DescribeWorkspaceImagesWithContext added in v1.15.78 

func (c *WorkSpaces) DescribeWorkspaceImagesWithContext(ctx aws.Context, input *DescribeWorkspaceImagesInput, opts ...request.Option) (*DescribeWorkspaceImagesOutput, error)

DescribeWorkspaceImagesWithContext is the same as DescribeWorkspaceImages with the addition of the ability to pass a context and additional request options.

See DescribeWorkspaceImages for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspaceSnapshots added in v1.20.11 

func (c *WorkSpaces) DescribeWorkspaceSnapshots(input *DescribeWorkspaceSnapshotsInput) (*DescribeWorkspaceSnapshotsOutput, error)

DescribeWorkspaceSnapshots API operation for Amazon WorkSpaces.

Describes the snapshots for the specified WorkSpace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeWorkspaceSnapshots for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceSnapshots

func (*WorkSpaces) DescribeWorkspaceSnapshotsRequest added in v1.20.11 

func (c *WorkSpaces) DescribeWorkspaceSnapshotsRequest(input *DescribeWorkspaceSnapshotsInput) (req *request.Request, output *DescribeWorkspaceSnapshotsOutput)

DescribeWorkspaceSnapshotsRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspaceSnapshots for more information on using the DescribeWorkspaceSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspaceSnapshotsRequest method.
req, resp := client.DescribeWorkspaceSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceSnapshots

func (*WorkSpaces) DescribeWorkspaceSnapshotsWithContext added in v1.20.11 

func (c *WorkSpaces) DescribeWorkspaceSnapshotsWithContext(ctx aws.Context, input *DescribeWorkspaceSnapshotsInput, opts ...request.Option) (*DescribeWorkspaceSnapshotsOutput, error)

DescribeWorkspaceSnapshotsWithContext is the same as DescribeWorkspaceSnapshots with the addition of the ability to pass a context and additional request options.

See DescribeWorkspaceSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspaces 

func (c *WorkSpaces) DescribeWorkspaces(input *DescribeWorkspacesInput) (*DescribeWorkspacesOutput, error)

DescribeWorkspaces API operation for Amazon WorkSpaces.

Describes the specified WorkSpaces.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeWorkspaces for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceUnavailableException The specified resource is not available.

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

func (*WorkSpaces) DescribeWorkspacesConnectionStatus added in v1.4.3 

func (c *WorkSpaces) DescribeWorkspacesConnectionStatus(input *DescribeWorkspacesConnectionStatusInput) (*DescribeWorkspacesConnectionStatusOutput, error)

DescribeWorkspacesConnectionStatus API operation for Amazon WorkSpaces.

Describes the connection status of the specified WorkSpaces.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DescribeWorkspacesConnectionStatus for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

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

func (*WorkSpaces) DescribeWorkspacesConnectionStatusRequest added in v1.4.3 

func (c *WorkSpaces) DescribeWorkspacesConnectionStatusRequest(input *DescribeWorkspacesConnectionStatusInput) (req *request.Request, output *DescribeWorkspacesConnectionStatusOutput)

DescribeWorkspacesConnectionStatusRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspacesConnectionStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspacesConnectionStatus for more information on using the DescribeWorkspacesConnectionStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspacesConnectionStatusRequest method.
req, resp := client.DescribeWorkspacesConnectionStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) DescribeWorkspacesConnectionStatusWithContext added in v1.8.0 

func (c *WorkSpaces) DescribeWorkspacesConnectionStatusWithContext(ctx aws.Context, input *DescribeWorkspacesConnectionStatusInput, opts ...request.Option) (*DescribeWorkspacesConnectionStatusOutput, error)

DescribeWorkspacesConnectionStatusWithContext is the same as DescribeWorkspacesConnectionStatus with the addition of the ability to pass a context and additional request options.

See DescribeWorkspacesConnectionStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspacesPages added in v0.6.5 

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

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

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

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

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

func (*WorkSpaces) DescribeWorkspacesPagesWithContext added in v1.8.0 

func (c *WorkSpaces) DescribeWorkspacesPagesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool, opts ...request.Option) error

DescribeWorkspacesPagesWithContext same as DescribeWorkspacesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DescribeWorkspacesRequest 

func (c *WorkSpaces) DescribeWorkspacesRequest(input *DescribeWorkspacesInput) (req *request.Request, output *DescribeWorkspacesOutput)

DescribeWorkspacesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspaces for more information on using the DescribeWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspacesRequest method.
req, resp := client.DescribeWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) DescribeWorkspacesWithContext added in v1.8.0 

func (c *WorkSpaces) DescribeWorkspacesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, opts ...request.Option) (*DescribeWorkspacesOutput, error)

DescribeWorkspacesWithContext is the same as DescribeWorkspaces with the addition of the ability to pass a context and additional request options.

See DescribeWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DisassociateConnectionAlias added in v1.34.22 

func (c *WorkSpaces) DisassociateConnectionAlias(input *DisassociateConnectionAliasInput) (*DisassociateConnectionAliasOutput, error)

DisassociateConnectionAlias API operation for Amazon WorkSpaces.

Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) to make sure that the current state of the connection alias is CREATED.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DisassociateConnectionAlias for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • ResourceNotFoundException The resource could not be found.

  • InvalidParameterValuesException One or more parameter values are not valid.

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

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAlias

func (*WorkSpaces) DisassociateConnectionAliasRequest added in v1.34.22 

func (c *WorkSpaces) DisassociateConnectionAliasRequest(input *DisassociateConnectionAliasInput) (req *request.Request, output *DisassociateConnectionAliasOutput)

DisassociateConnectionAliasRequest generates a "aws/request.Request" representing the client's request for the DisassociateConnectionAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateConnectionAlias for more information on using the DisassociateConnectionAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateConnectionAliasRequest method.
req, resp := client.DisassociateConnectionAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAlias

func (*WorkSpaces) DisassociateConnectionAliasWithContext added in v1.34.22 

func (c *WorkSpaces) DisassociateConnectionAliasWithContext(ctx aws.Context, input *DisassociateConnectionAliasInput, opts ...request.Option) (*DisassociateConnectionAliasOutput, error)

DisassociateConnectionAliasWithContext is the same as DisassociateConnectionAlias with the addition of the ability to pass a context and additional request options.

See DisassociateConnectionAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DisassociateIpGroups added in v1.13.39 

func (c *WorkSpaces) DisassociateIpGroups(input *DisassociateIpGroupsInput) (*DisassociateIpGroupsOutput, error)

DisassociateIpGroups API operation for Amazon WorkSpaces.

Disassociates the specified IP access control group from the specified directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DisassociateIpGroups for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

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

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateIpGroups

func (*WorkSpaces) DisassociateIpGroupsRequest added in v1.13.39 

func (c *WorkSpaces) DisassociateIpGroupsRequest(input *DisassociateIpGroupsInput) (req *request.Request, output *DisassociateIpGroupsOutput)

DisassociateIpGroupsRequest generates a "aws/request.Request" representing the client's request for the DisassociateIpGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateIpGroups for more information on using the DisassociateIpGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateIpGroupsRequest method.
req, resp := client.DisassociateIpGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateIpGroups

func (*WorkSpaces) DisassociateIpGroupsWithContext added in v1.13.39 

func (c *WorkSpaces) DisassociateIpGroupsWithContext(ctx aws.Context, input *DisassociateIpGroupsInput, opts ...request.Option) (*DisassociateIpGroupsOutput, error)

DisassociateIpGroupsWithContext is the same as DisassociateIpGroups with the addition of the ability to pass a context and additional request options.

See DisassociateIpGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) DisassociateWorkspaceApplication added in v1.45.23 

func (c *WorkSpaces) DisassociateWorkspaceApplication(input *DisassociateWorkspaceApplicationInput) (*DisassociateWorkspaceApplicationOutput, error)

DisassociateWorkspaceApplication API operation for Amazon WorkSpaces.

Disassociates the specified application from a WorkSpace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation DisassociateWorkspaceApplication for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceInUseException The specified resource is currently in use.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateWorkspaceApplication

func (*WorkSpaces) DisassociateWorkspaceApplicationRequest added in v1.45.23 

func (c *WorkSpaces) DisassociateWorkspaceApplicationRequest(input *DisassociateWorkspaceApplicationInput) (req *request.Request, output *DisassociateWorkspaceApplicationOutput)

DisassociateWorkspaceApplicationRequest generates a "aws/request.Request" representing the client's request for the DisassociateWorkspaceApplication operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateWorkspaceApplication for more information on using the DisassociateWorkspaceApplication API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateWorkspaceApplicationRequest method.
req, resp := client.DisassociateWorkspaceApplicationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateWorkspaceApplication

func (*WorkSpaces) DisassociateWorkspaceApplicationWithContext added in v1.45.23 

func (c *WorkSpaces) DisassociateWorkspaceApplicationWithContext(ctx aws.Context, input *DisassociateWorkspaceApplicationInput, opts ...request.Option) (*DisassociateWorkspaceApplicationOutput, error)

DisassociateWorkspaceApplicationWithContext is the same as DisassociateWorkspaceApplication with the addition of the ability to pass a context and additional request options.

See DisassociateWorkspaceApplication for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ImportClientBranding added in v1.43.30 

func (c *WorkSpaces) ImportClientBranding(input *ImportClientBrandingInput) (*ImportClientBrandingOutput, error)

ImportClientBranding API operation for Amazon WorkSpaces.

Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience

  • You must specify at least one platform type when importing client branding.

  • You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.

  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.

  • Imported data can take up to a minute to appear in the WorkSpaces client.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ImportClientBranding for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportClientBranding

func (*WorkSpaces) ImportClientBrandingRequest added in v1.43.30 

func (c *WorkSpaces) ImportClientBrandingRequest(input *ImportClientBrandingInput) (req *request.Request, output *ImportClientBrandingOutput)

ImportClientBrandingRequest generates a "aws/request.Request" representing the client's request for the ImportClientBranding operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportClientBranding for more information on using the ImportClientBranding API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ImportClientBrandingRequest method.
req, resp := client.ImportClientBrandingRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportClientBranding

func (*WorkSpaces) ImportClientBrandingWithContext added in v1.43.30 

func (c *WorkSpaces) ImportClientBrandingWithContext(ctx aws.Context, input *ImportClientBrandingInput, opts ...request.Option) (*ImportClientBrandingOutput, error)

ImportClientBrandingWithContext is the same as ImportClientBranding with the addition of the ability to pass a context and additional request options.

See ImportClientBranding for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ImportWorkspaceImage added in v1.15.78 

func (c *WorkSpaces) ImportWorkspaceImage(input *ImportWorkspaceImageInput) (*ImportWorkspaceImageOutput, error)

ImportWorkspaceImage API operation for Amazon WorkSpaces.

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ImportWorkspaceImage for usage and error information.

Returned Error Types:

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • ResourceAlreadyExistsException The specified resource already exists.

  • ResourceNotFoundException The resource could not be found.

  • OperationNotSupportedException This operation is not supported.

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportWorkspaceImage

func (*WorkSpaces) ImportWorkspaceImageRequest added in v1.15.78 

func (c *WorkSpaces) ImportWorkspaceImageRequest(input *ImportWorkspaceImageInput) (req *request.Request, output *ImportWorkspaceImageOutput)

ImportWorkspaceImageRequest generates a "aws/request.Request" representing the client's request for the ImportWorkspaceImage operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportWorkspaceImage for more information on using the ImportWorkspaceImage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ImportWorkspaceImageRequest method.
req, resp := client.ImportWorkspaceImageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportWorkspaceImage

func (*WorkSpaces) ImportWorkspaceImageWithContext added in v1.15.78 

func (c *WorkSpaces) ImportWorkspaceImageWithContext(ctx aws.Context, input *ImportWorkspaceImageInput, opts ...request.Option) (*ImportWorkspaceImageOutput, error)

ImportWorkspaceImageWithContext is the same as ImportWorkspaceImage with the addition of the ability to pass a context and additional request options.

See ImportWorkspaceImage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ListAvailableManagementCidrRanges added in v1.15.78 

func (c *WorkSpaces) ListAvailableManagementCidrRanges(input *ListAvailableManagementCidrRangesInput) (*ListAvailableManagementCidrRangesOutput, error)

ListAvailableManagementCidrRanges API operation for Amazon WorkSpaces.

Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).

This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error.

The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ListAvailableManagementCidrRanges for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ListAvailableManagementCidrRanges

func (*WorkSpaces) ListAvailableManagementCidrRangesRequest added in v1.15.78 

func (c *WorkSpaces) ListAvailableManagementCidrRangesRequest(input *ListAvailableManagementCidrRangesInput) (req *request.Request, output *ListAvailableManagementCidrRangesOutput)

ListAvailableManagementCidrRangesRequest generates a "aws/request.Request" representing the client's request for the ListAvailableManagementCidrRanges operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAvailableManagementCidrRanges for more information on using the ListAvailableManagementCidrRanges API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAvailableManagementCidrRangesRequest method.
req, resp := client.ListAvailableManagementCidrRangesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ListAvailableManagementCidrRanges

func (*WorkSpaces) ListAvailableManagementCidrRangesWithContext added in v1.15.78 

func (c *WorkSpaces) ListAvailableManagementCidrRangesWithContext(ctx aws.Context, input *ListAvailableManagementCidrRangesInput, opts ...request.Option) (*ListAvailableManagementCidrRangesOutput, error)

ListAvailableManagementCidrRangesWithContext is the same as ListAvailableManagementCidrRanges with the addition of the ability to pass a context and additional request options.

See ListAvailableManagementCidrRanges for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) MigrateWorkspace added in v1.28.0 

func (c *WorkSpaces) MigrateWorkspace(input *MigrateWorkspaceInput) (*MigrateWorkspaceOutput, error)

MigrateWorkspace API operation for Amazon WorkSpaces.

Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.

The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation MigrateWorkspace for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

  • OperationNotSupportedException This operation is not supported.

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

  • ResourceUnavailableException The specified resource is not available.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/MigrateWorkspace

func (*WorkSpaces) MigrateWorkspaceRequest added in v1.28.0 

func (c *WorkSpaces) MigrateWorkspaceRequest(input *MigrateWorkspaceInput) (req *request.Request, output *MigrateWorkspaceOutput)

MigrateWorkspaceRequest generates a "aws/request.Request" representing the client's request for the MigrateWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See MigrateWorkspace for more information on using the MigrateWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the MigrateWorkspaceRequest method.
req, resp := client.MigrateWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/MigrateWorkspace

func (*WorkSpaces) MigrateWorkspaceWithContext added in v1.28.0 

func (c *WorkSpaces) MigrateWorkspaceWithContext(ctx aws.Context, input *MigrateWorkspaceInput, opts ...request.Option) (*MigrateWorkspaceOutput, error)

MigrateWorkspaceWithContext is the same as MigrateWorkspace with the addition of the ability to pass a context and additional request options.

See MigrateWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ModifyAccount added in v1.15.78 

func (c *WorkSpaces) ModifyAccount(input *ModifyAccountInput) (*ModifyAccountOutput, error)

ModifyAccount API operation for Amazon WorkSpaces.

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ModifyAccount for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • AccessDeniedException The user is not authorized to access a resource.

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

  • ResourceUnavailableException The specified resource is not available.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyAccount

func (*WorkSpaces) ModifyAccountRequest added in v1.15.78 

func (c *WorkSpaces) ModifyAccountRequest(input *ModifyAccountInput) (req *request.Request, output *ModifyAccountOutput)

ModifyAccountRequest generates a "aws/request.Request" representing the client's request for the ModifyAccount operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyAccount for more information on using the ModifyAccount API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ModifyAccountRequest method.
req, resp := client.ModifyAccountRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyAccount

func (*WorkSpaces) ModifyAccountWithContext added in v1.15.78 

func (c *WorkSpaces) ModifyAccountWithContext(ctx aws.Context, input *ModifyAccountInput, opts ...request.Option) (*ModifyAccountOutput, error)

ModifyAccountWithContext is the same as ModifyAccount with the addition of the ability to pass a context and additional request options.

See ModifyAccount for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ModifyCertificateBasedAuthProperties added in v1.44.138 

func (c *WorkSpaces) ModifyCertificateBasedAuthProperties(input *ModifyCertificateBasedAuthPropertiesInput) (*ModifyCertificateBasedAuthPropertiesOutput, error)

ModifyCertificateBasedAuthProperties API operation for Amazon WorkSpaces.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ModifyCertificateBasedAuthProperties for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties

func (*WorkSpaces) ModifyCertificateBasedAuthPropertiesRequest added in v1.44.138 

func (c *WorkSpaces) ModifyCertificateBasedAuthPropertiesRequest(input *ModifyCertificateBasedAuthPropertiesInput) (req *request.Request, output *ModifyCertificateBasedAuthPropertiesOutput)

ModifyCertificateBasedAuthPropertiesRequest generates a "aws/request.Request" representing the client's request for the ModifyCertificateBasedAuthProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyCertificateBasedAuthProperties for more information on using the ModifyCertificateBasedAuthProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ModifyCertificateBasedAuthPropertiesRequest method.
req, resp := client.ModifyCertificateBasedAuthPropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties

func (*WorkSpaces) ModifyCertificateBasedAuthPropertiesWithContext added in v1.44.138 

func (c *WorkSpaces) ModifyCertificateBasedAuthPropertiesWithContext(ctx aws.Context, input *ModifyCertificateBasedAuthPropertiesInput, opts ...request.Option) (*ModifyCertificateBasedAuthPropertiesOutput, error)

ModifyCertificateBasedAuthPropertiesWithContext is the same as ModifyCertificateBasedAuthProperties with the addition of the ability to pass a context and additional request options.

See ModifyCertificateBasedAuthProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ModifyClientProperties added in v1.15.79 

func (c *WorkSpaces) ModifyClientProperties(input *ModifyClientPropertiesInput) (*ModifyClientPropertiesOutput, error)

ModifyClientProperties API operation for Amazon WorkSpaces.

Modifies the properties of the specified Amazon WorkSpaces clients.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ModifyClientProperties for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyClientProperties

func (*WorkSpaces) ModifyClientPropertiesRequest added in v1.15.79 

func (c *WorkSpaces) ModifyClientPropertiesRequest(input *ModifyClientPropertiesInput) (req *request.Request, output *ModifyClientPropertiesOutput)

ModifyClientPropertiesRequest generates a "aws/request.Request" representing the client's request for the ModifyClientProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyClientProperties for more information on using the ModifyClientProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ModifyClientPropertiesRequest method.
req, resp := client.ModifyClientPropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyClientProperties

func (*WorkSpaces) ModifyClientPropertiesWithContext added in v1.15.79 

func (c *WorkSpaces) ModifyClientPropertiesWithContext(ctx aws.Context, input *ModifyClientPropertiesInput, opts ...request.Option) (*ModifyClientPropertiesOutput, error)

ModifyClientPropertiesWithContext is the same as ModifyClientProperties with the addition of the ability to pass a context and additional request options.

See ModifyClientProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ModifySamlProperties added in v1.44.67 

func (c *WorkSpaces) ModifySamlProperties(input *ModifySamlPropertiesInput) (*ModifySamlPropertiesOutput, error)

ModifySamlProperties API operation for Amazon WorkSpaces.

Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ModifySamlProperties for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlProperties

func (*WorkSpaces) ModifySamlPropertiesRequest added in v1.44.67 

func (c *WorkSpaces) ModifySamlPropertiesRequest(input *ModifySamlPropertiesInput) (req *request.Request, output *ModifySamlPropertiesOutput)

ModifySamlPropertiesRequest generates a "aws/request.Request" representing the client's request for the ModifySamlProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifySamlProperties for more information on using the ModifySamlProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ModifySamlPropertiesRequest method.
req, resp := client.ModifySamlPropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlProperties

func (*WorkSpaces) ModifySamlPropertiesWithContext added in v1.44.67 

func (c *WorkSpaces) ModifySamlPropertiesWithContext(ctx aws.Context, input *ModifySamlPropertiesInput, opts ...request.Option) (*ModifySamlPropertiesOutput, error)

ModifySamlPropertiesWithContext is the same as ModifySamlProperties with the addition of the ability to pass a context and additional request options.

See ModifySamlProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ModifySelfservicePermissions added in v1.25.36 

func (c *WorkSpaces) ModifySelfservicePermissions(input *ModifySelfservicePermissionsInput) (*ModifySelfservicePermissionsOutput, error)

ModifySelfservicePermissions API operation for Amazon WorkSpaces.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ModifySelfservicePermissions for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySelfservicePermissions

func (*WorkSpaces) ModifySelfservicePermissionsRequest added in v1.25.36 

func (c *WorkSpaces) ModifySelfservicePermissionsRequest(input *ModifySelfservicePermissionsInput) (req *request.Request, output *ModifySelfservicePermissionsOutput)

ModifySelfservicePermissionsRequest generates a "aws/request.Request" representing the client's request for the ModifySelfservicePermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifySelfservicePermissions for more information on using the ModifySelfservicePermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ModifySelfservicePermissionsRequest method.
req, resp := client.ModifySelfservicePermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySelfservicePermissions

func (*WorkSpaces) ModifySelfservicePermissionsWithContext added in v1.25.36 

func (c *WorkSpaces) ModifySelfservicePermissionsWithContext(ctx aws.Context, input *ModifySelfservicePermissionsInput, opts ...request.Option) (*ModifySelfservicePermissionsOutput, error)

ModifySelfservicePermissionsWithContext is the same as ModifySelfservicePermissions with the addition of the ability to pass a context and additional request options.

See ModifySelfservicePermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ModifyWorkspaceAccessProperties added in v1.25.36 

func (c *WorkSpaces) ModifyWorkspaceAccessProperties(input *ModifyWorkspaceAccessPropertiesInput) (*ModifyWorkspaceAccessPropertiesOutput, error)

ModifyWorkspaceAccessProperties API operation for Amazon WorkSpaces.

Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ModifyWorkspaceAccessProperties for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceAccessProperties

func (*WorkSpaces) ModifyWorkspaceAccessPropertiesRequest added in v1.25.36 

func (c *WorkSpaces) ModifyWorkspaceAccessPropertiesRequest(input *ModifyWorkspaceAccessPropertiesInput) (req *request.Request, output *ModifyWorkspaceAccessPropertiesOutput)

ModifyWorkspaceAccessPropertiesRequest generates a "aws/request.Request" representing the client's request for the ModifyWorkspaceAccessProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyWorkspaceAccessProperties for more information on using the ModifyWorkspaceAccessProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ModifyWorkspaceAccessPropertiesRequest method.
req, resp := client.ModifyWorkspaceAccessPropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceAccessProperties

func (*WorkSpaces) ModifyWorkspaceAccessPropertiesWithContext added in v1.25.36 

func (c *WorkSpaces) ModifyWorkspaceAccessPropertiesWithContext(ctx aws.Context, input *ModifyWorkspaceAccessPropertiesInput, opts ...request.Option) (*ModifyWorkspaceAccessPropertiesOutput, error)

ModifyWorkspaceAccessPropertiesWithContext is the same as ModifyWorkspaceAccessProperties with the addition of the ability to pass a context and additional request options.

See ModifyWorkspaceAccessProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ModifyWorkspaceCreationProperties added in v1.25.36 

func (c *WorkSpaces) ModifyWorkspaceCreationProperties(input *ModifyWorkspaceCreationPropertiesInput) (*ModifyWorkspaceCreationPropertiesOutput, error)

ModifyWorkspaceCreationProperties API operation for Amazon WorkSpaces.

Modify the default properties used to create WorkSpaces.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ModifyWorkspaceCreationProperties for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceCreationProperties

func (*WorkSpaces) ModifyWorkspaceCreationPropertiesRequest added in v1.25.36 

func (c *WorkSpaces) ModifyWorkspaceCreationPropertiesRequest(input *ModifyWorkspaceCreationPropertiesInput) (req *request.Request, output *ModifyWorkspaceCreationPropertiesOutput)

ModifyWorkspaceCreationPropertiesRequest generates a "aws/request.Request" representing the client's request for the ModifyWorkspaceCreationProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyWorkspaceCreationProperties for more information on using the ModifyWorkspaceCreationProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ModifyWorkspaceCreationPropertiesRequest method.
req, resp := client.ModifyWorkspaceCreationPropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceCreationProperties

func (*WorkSpaces) ModifyWorkspaceCreationPropertiesWithContext added in v1.25.36 

func (c *WorkSpaces) ModifyWorkspaceCreationPropertiesWithContext(ctx aws.Context, input *ModifyWorkspaceCreationPropertiesInput, opts ...request.Option) (*ModifyWorkspaceCreationPropertiesOutput, error)

ModifyWorkspaceCreationPropertiesWithContext is the same as ModifyWorkspaceCreationProperties with the addition of the ability to pass a context and additional request options.

See ModifyWorkspaceCreationProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ModifyWorkspaceProperties added in v1.4.3 

func (c *WorkSpaces) ModifyWorkspaceProperties(input *ModifyWorkspacePropertiesInput) (*ModifyWorkspacePropertiesOutput, error)

ModifyWorkspaceProperties API operation for Amazon WorkSpaces.

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

The MANUAL running mode 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 (http://aws.amazon.com/workspaces/core/).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ModifyWorkspaceProperties for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

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

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

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

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

  • ResourceUnavailableException The specified resource is not available.

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

func (*WorkSpaces) ModifyWorkspacePropertiesRequest added in v1.4.3 

func (c *WorkSpaces) ModifyWorkspacePropertiesRequest(input *ModifyWorkspacePropertiesInput) (req *request.Request, output *ModifyWorkspacePropertiesOutput)

ModifyWorkspacePropertiesRequest generates a "aws/request.Request" representing the client's request for the ModifyWorkspaceProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyWorkspaceProperties for more information on using the ModifyWorkspaceProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ModifyWorkspacePropertiesRequest method.
req, resp := client.ModifyWorkspacePropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) ModifyWorkspacePropertiesWithContext added in v1.8.0 

func (c *WorkSpaces) ModifyWorkspacePropertiesWithContext(ctx aws.Context, input *ModifyWorkspacePropertiesInput, opts ...request.Option) (*ModifyWorkspacePropertiesOutput, error)

ModifyWorkspacePropertiesWithContext is the same as ModifyWorkspaceProperties with the addition of the ability to pass a context and additional request options.

See ModifyWorkspaceProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) ModifyWorkspaceState added in v1.13.39 

func (c *WorkSpaces) ModifyWorkspaceState(input *ModifyWorkspaceStateInput) (*ModifyWorkspaceStateOutput, error)

ModifyWorkspaceState API operation for Amazon WorkSpaces.

Sets the state of the specified WorkSpace.

To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation ModifyWorkspaceState for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

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

  • ResourceNotFoundException The resource could not be found.

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceState

func (*WorkSpaces) ModifyWorkspaceStateRequest added in v1.13.39 

func (c *WorkSpaces) ModifyWorkspaceStateRequest(input *ModifyWorkspaceStateInput) (req *request.Request, output *ModifyWorkspaceStateOutput)

ModifyWorkspaceStateRequest generates a "aws/request.Request" representing the client's request for the ModifyWorkspaceState operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ModifyWorkspaceState for more information on using the ModifyWorkspaceState API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ModifyWorkspaceStateRequest method.
req, resp := client.ModifyWorkspaceStateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceState

func (*WorkSpaces) ModifyWorkspaceStateWithContext added in v1.13.39 

func (c *WorkSpaces) ModifyWorkspaceStateWithContext(ctx aws.Context, input *ModifyWorkspaceStateInput, opts ...request.Option) (*ModifyWorkspaceStateOutput, error)

ModifyWorkspaceStateWithContext is the same as ModifyWorkspaceState with the addition of the ability to pass a context and additional request options.

See ModifyWorkspaceState for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) RebootWorkspaces 

func (c *WorkSpaces) RebootWorkspaces(input *RebootWorkspacesInput) (*RebootWorkspacesOutput, error)

RebootWorkspaces API operation for Amazon WorkSpaces.

Reboots the specified WorkSpaces.

You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation RebootWorkspaces for usage and error information.

Returned Error Types:

  • OperationNotSupportedException This operation is not supported.

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

func (*WorkSpaces) RebootWorkspacesRequest 

func (c *WorkSpaces) RebootWorkspacesRequest(input *RebootWorkspacesInput) (req *request.Request, output *RebootWorkspacesOutput)

RebootWorkspacesRequest generates a "aws/request.Request" representing the client's request for the RebootWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebootWorkspaces for more information on using the RebootWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RebootWorkspacesRequest method.
req, resp := client.RebootWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) RebootWorkspacesWithContext added in v1.8.0 

func (c *WorkSpaces) RebootWorkspacesWithContext(ctx aws.Context, input *RebootWorkspacesInput, opts ...request.Option) (*RebootWorkspacesOutput, error)

RebootWorkspacesWithContext is the same as RebootWorkspaces with the addition of the ability to pass a context and additional request options.

See RebootWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) RebuildWorkspaces 

func (c *WorkSpaces) RebuildWorkspaces(input *RebuildWorkspacesInput) (*RebuildWorkspacesOutput, error)

RebuildWorkspaces API operation for Amazon WorkSpaces.

Rebuilds the specified WorkSpace.

You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation RebuildWorkspaces for usage and error information.

Returned Error Types:

  • OperationNotSupportedException This operation is not supported.

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

func (*WorkSpaces) RebuildWorkspacesRequest 

func (c *WorkSpaces) RebuildWorkspacesRequest(input *RebuildWorkspacesInput) (req *request.Request, output *RebuildWorkspacesOutput)

RebuildWorkspacesRequest generates a "aws/request.Request" representing the client's request for the RebuildWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RebuildWorkspaces for more information on using the RebuildWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RebuildWorkspacesRequest method.
req, resp := client.RebuildWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) RebuildWorkspacesWithContext added in v1.8.0 

func (c *WorkSpaces) RebuildWorkspacesWithContext(ctx aws.Context, input *RebuildWorkspacesInput, opts ...request.Option) (*RebuildWorkspacesOutput, error)

RebuildWorkspacesWithContext is the same as RebuildWorkspaces with the addition of the ability to pass a context and additional request options.

See RebuildWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) RegisterWorkspaceDirectory added in v1.25.36 

func (c *WorkSpaces) RegisterWorkspaceDirectory(input *RegisterWorkspaceDirectoryInput) (*RegisterWorkspaceDirectoryOutput, error)

RegisterWorkspaceDirectory API operation for Amazon WorkSpaces.

Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation RegisterWorkspaceDirectory for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • AccessDeniedException The user is not authorized to access a resource.

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

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

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

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectory

func (*WorkSpaces) RegisterWorkspaceDirectoryRequest added in v1.25.36 

func (c *WorkSpaces) RegisterWorkspaceDirectoryRequest(input *RegisterWorkspaceDirectoryInput) (req *request.Request, output *RegisterWorkspaceDirectoryOutput)

RegisterWorkspaceDirectoryRequest generates a "aws/request.Request" representing the client's request for the RegisterWorkspaceDirectory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterWorkspaceDirectory for more information on using the RegisterWorkspaceDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RegisterWorkspaceDirectoryRequest method.
req, resp := client.RegisterWorkspaceDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectory

func (*WorkSpaces) RegisterWorkspaceDirectoryWithContext added in v1.25.36 

func (c *WorkSpaces) RegisterWorkspaceDirectoryWithContext(ctx aws.Context, input *RegisterWorkspaceDirectoryInput, opts ...request.Option) (*RegisterWorkspaceDirectoryOutput, error)

RegisterWorkspaceDirectoryWithContext is the same as RegisterWorkspaceDirectory with the addition of the ability to pass a context and additional request options.

See RegisterWorkspaceDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) RestoreWorkspace added in v1.20.11 

func (c *WorkSpaces) RestoreWorkspace(input *RestoreWorkspaceInput) (*RestoreWorkspaceOutput, error)

RestoreWorkspace API operation for Amazon WorkSpaces.

Restores the specified WorkSpace to its last known healthy state.

You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.

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

This operation is asynchronous and returns before the WorkSpace is completely restored.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation RestoreWorkspace for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RestoreWorkspace

func (*WorkSpaces) RestoreWorkspaceRequest added in v1.20.11 

func (c *WorkSpaces) RestoreWorkspaceRequest(input *RestoreWorkspaceInput) (req *request.Request, output *RestoreWorkspaceOutput)

RestoreWorkspaceRequest generates a "aws/request.Request" representing the client's request for the RestoreWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreWorkspace for more information on using the RestoreWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RestoreWorkspaceRequest method.
req, resp := client.RestoreWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RestoreWorkspace

func (*WorkSpaces) RestoreWorkspaceWithContext added in v1.20.11 

func (c *WorkSpaces) RestoreWorkspaceWithContext(ctx aws.Context, input *RestoreWorkspaceInput, opts ...request.Option) (*RestoreWorkspaceOutput, error)

RestoreWorkspaceWithContext is the same as RestoreWorkspace with the addition of the ability to pass a context and additional request options.

See RestoreWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) RevokeIpRules added in v1.13.39 

func (c *WorkSpaces) RevokeIpRules(input *RevokeIpRulesInput) (*RevokeIpRulesOutput, error)

RevokeIpRules API operation for Amazon WorkSpaces.

Removes one or more rules from the specified IP access control group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation RevokeIpRules for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

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

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RevokeIpRules

func (*WorkSpaces) RevokeIpRulesRequest added in v1.13.39 

func (c *WorkSpaces) RevokeIpRulesRequest(input *RevokeIpRulesInput) (req *request.Request, output *RevokeIpRulesOutput)

RevokeIpRulesRequest generates a "aws/request.Request" representing the client's request for the RevokeIpRules operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RevokeIpRules for more information on using the RevokeIpRules API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RevokeIpRulesRequest method.
req, resp := client.RevokeIpRulesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RevokeIpRules

func (*WorkSpaces) RevokeIpRulesWithContext added in v1.13.39 

func (c *WorkSpaces) RevokeIpRulesWithContext(ctx aws.Context, input *RevokeIpRulesInput, opts ...request.Option) (*RevokeIpRulesOutput, error)

RevokeIpRulesWithContext is the same as RevokeIpRules with the addition of the ability to pass a context and additional request options.

See RevokeIpRules for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) StartWorkspaces added in v1.4.3 

func (c *WorkSpaces) StartWorkspaces(input *StartWorkspacesInput) (*StartWorkspacesOutput, error)

StartWorkspaces API operation for Amazon WorkSpaces.

Starts the specified WorkSpaces.

You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation StartWorkspaces for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces

func (*WorkSpaces) StartWorkspacesRequest added in v1.4.3 

func (c *WorkSpaces) StartWorkspacesRequest(input *StartWorkspacesInput) (req *request.Request, output *StartWorkspacesOutput)

StartWorkspacesRequest generates a "aws/request.Request" representing the client's request for the StartWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartWorkspaces for more information on using the StartWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartWorkspacesRequest method.
req, resp := client.StartWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) StartWorkspacesWithContext added in v1.8.0 

func (c *WorkSpaces) StartWorkspacesWithContext(ctx aws.Context, input *StartWorkspacesInput, opts ...request.Option) (*StartWorkspacesOutput, error)

StartWorkspacesWithContext is the same as StartWorkspaces with the addition of the ability to pass a context and additional request options.

See StartWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) StopWorkspaces added in v1.4.3 

func (c *WorkSpaces) StopWorkspaces(input *StopWorkspacesInput) (*StopWorkspacesOutput, error)

StopWorkspaces API operation for Amazon WorkSpaces.

Stops the specified WorkSpaces.

You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation StopWorkspaces for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces

func (*WorkSpaces) StopWorkspacesRequest added in v1.4.3 

func (c *WorkSpaces) StopWorkspacesRequest(input *StopWorkspacesInput) (req *request.Request, output *StopWorkspacesOutput)

StopWorkspacesRequest generates a "aws/request.Request" representing the client's request for the StopWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopWorkspaces for more information on using the StopWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopWorkspacesRequest method.
req, resp := client.StopWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) StopWorkspacesWithContext added in v1.8.0 

func (c *WorkSpaces) StopWorkspacesWithContext(ctx aws.Context, input *StopWorkspacesInput, opts ...request.Option) (*StopWorkspacesOutput, error)

StopWorkspacesWithContext is the same as StopWorkspaces with the addition of the ability to pass a context and additional request options.

See StopWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) TerminateWorkspaces 

func (c *WorkSpaces) TerminateWorkspaces(input *TerminateWorkspacesInput) (*TerminateWorkspacesOutput, error)

TerminateWorkspaces API operation for Amazon WorkSpaces.

Terminates the specified WorkSpaces.

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

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

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

Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms (http://aws.amazon.com/directoryservice/pricing/).

To delete empty directories, see Delete the Directory for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation TerminateWorkspaces for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces

func (*WorkSpaces) TerminateWorkspacesRequest 

func (c *WorkSpaces) TerminateWorkspacesRequest(input *TerminateWorkspacesInput) (req *request.Request, output *TerminateWorkspacesOutput)

TerminateWorkspacesRequest generates a "aws/request.Request" representing the client's request for the TerminateWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TerminateWorkspaces for more information on using the TerminateWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TerminateWorkspacesRequest method.
req, resp := client.TerminateWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*WorkSpaces) TerminateWorkspacesWithContext added in v1.8.0 

func (c *WorkSpaces) TerminateWorkspacesWithContext(ctx aws.Context, input *TerminateWorkspacesInput, opts ...request.Option) (*TerminateWorkspacesOutput, error)

TerminateWorkspacesWithContext is the same as TerminateWorkspaces with the addition of the ability to pass a context and additional request options.

See TerminateWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) UpdateConnectClientAddIn added in v1.42.32 

func (c *WorkSpaces) UpdateConnectClientAddIn(input *UpdateConnectClientAddInInput) (*UpdateConnectClientAddInOutput, error)

UpdateConnectClientAddIn API operation for Amazon WorkSpaces.

Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation UpdateConnectClientAddIn for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectClientAddIn

func (*WorkSpaces) UpdateConnectClientAddInRequest added in v1.42.32 

func (c *WorkSpaces) UpdateConnectClientAddInRequest(input *UpdateConnectClientAddInInput) (req *request.Request, output *UpdateConnectClientAddInOutput)

UpdateConnectClientAddInRequest generates a "aws/request.Request" representing the client's request for the UpdateConnectClientAddIn operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConnectClientAddIn for more information on using the UpdateConnectClientAddIn API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateConnectClientAddInRequest method.
req, resp := client.UpdateConnectClientAddInRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectClientAddIn

func (*WorkSpaces) UpdateConnectClientAddInWithContext added in v1.42.32 

func (c *WorkSpaces) UpdateConnectClientAddInWithContext(ctx aws.Context, input *UpdateConnectClientAddInInput, opts ...request.Option) (*UpdateConnectClientAddInOutput, error)

UpdateConnectClientAddInWithContext is the same as UpdateConnectClientAddIn with the addition of the ability to pass a context and additional request options.

See UpdateConnectClientAddIn for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) UpdateConnectionAliasPermission added in v1.34.22 

func (c *WorkSpaces) UpdateConnectionAliasPermission(input *UpdateConnectionAliasPermissionInput) (*UpdateConnectionAliasPermissionOutput, error)

UpdateConnectionAliasPermission API operation for Amazon WorkSpaces.

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

  • Before performing this operation, call DescribeConnectionAliases (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) to make sure that the current state of the connection alias is CREATED.

  • To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation UpdateConnectionAliasPermission for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceLimitExceededException Your resource limits have been exceeded.

  • ResourceNotFoundException The resource could not be found.

  • ResourceAssociatedException The resource is associated with a directory.

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

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermission

func (*WorkSpaces) UpdateConnectionAliasPermissionRequest added in v1.34.22 

func (c *WorkSpaces) UpdateConnectionAliasPermissionRequest(input *UpdateConnectionAliasPermissionInput) (req *request.Request, output *UpdateConnectionAliasPermissionOutput)

UpdateConnectionAliasPermissionRequest generates a "aws/request.Request" representing the client's request for the UpdateConnectionAliasPermission operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateConnectionAliasPermission for more information on using the UpdateConnectionAliasPermission API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateConnectionAliasPermissionRequest method.
req, resp := client.UpdateConnectionAliasPermissionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermission

func (*WorkSpaces) UpdateConnectionAliasPermissionWithContext added in v1.34.22 

func (c *WorkSpaces) UpdateConnectionAliasPermissionWithContext(ctx aws.Context, input *UpdateConnectionAliasPermissionInput, opts ...request.Option) (*UpdateConnectionAliasPermissionOutput, error)

UpdateConnectionAliasPermissionWithContext is the same as UpdateConnectionAliasPermission with the addition of the ability to pass a context and additional request options.

See UpdateConnectionAliasPermission for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) UpdateRulesOfIpGroup added in v1.13.39 

func (c *WorkSpaces) UpdateRulesOfIpGroup(input *UpdateRulesOfIpGroupInput) (*UpdateRulesOfIpGroupOutput, error)

UpdateRulesOfIpGroup API operation for Amazon WorkSpaces.

Replaces the current rules of the specified IP access control group with the specified rules.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation UpdateRulesOfIpGroup for usage and error information.

Returned Error Types:

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • ResourceLimitExceededException Your resource limits have been exceeded.

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

  • AccessDeniedException The user is not authorized to access a resource.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateRulesOfIpGroup

func (*WorkSpaces) UpdateRulesOfIpGroupRequest added in v1.13.39 

func (c *WorkSpaces) UpdateRulesOfIpGroupRequest(input *UpdateRulesOfIpGroupInput) (req *request.Request, output *UpdateRulesOfIpGroupOutput)

UpdateRulesOfIpGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateRulesOfIpGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRulesOfIpGroup for more information on using the UpdateRulesOfIpGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateRulesOfIpGroupRequest method.
req, resp := client.UpdateRulesOfIpGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateRulesOfIpGroup

func (*WorkSpaces) UpdateRulesOfIpGroupWithContext added in v1.13.39 

func (c *WorkSpaces) UpdateRulesOfIpGroupWithContext(ctx aws.Context, input *UpdateRulesOfIpGroupInput, opts ...request.Option) (*UpdateRulesOfIpGroupOutput, error)

UpdateRulesOfIpGroupWithContext is the same as UpdateRulesOfIpGroup with the addition of the ability to pass a context and additional request options.

See UpdateRulesOfIpGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) UpdateWorkspaceBundle added in v1.37.30 

func (c *WorkSpaces) UpdateWorkspaceBundle(input *UpdateWorkspaceBundleInput) (*UpdateWorkspaceBundleOutput, error)

UpdateWorkspaceBundle API operation for Amazon WorkSpaces.

Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html).

Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation UpdateWorkspaceBundle for usage and error information.

Returned Error Types:

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • ResourceNotFoundException The resource could not be found.

  • ResourceUnavailableException The specified resource is not available.

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceBundle

func (*WorkSpaces) UpdateWorkspaceBundleRequest added in v1.37.30 

func (c *WorkSpaces) UpdateWorkspaceBundleRequest(input *UpdateWorkspaceBundleInput) (req *request.Request, output *UpdateWorkspaceBundleOutput)

UpdateWorkspaceBundleRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkspaceBundle operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkspaceBundle for more information on using the UpdateWorkspaceBundle API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateWorkspaceBundleRequest method.
req, resp := client.UpdateWorkspaceBundleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceBundle

func (*WorkSpaces) UpdateWorkspaceBundleWithContext added in v1.37.30 

func (c *WorkSpaces) UpdateWorkspaceBundleWithContext(ctx aws.Context, input *UpdateWorkspaceBundleInput, opts ...request.Option) (*UpdateWorkspaceBundleOutput, error)

UpdateWorkspaceBundleWithContext is the same as UpdateWorkspaceBundle with the addition of the ability to pass a context and additional request options.

See UpdateWorkspaceBundle for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WorkSpaces) UpdateWorkspaceImagePermission added in v1.33.11 

func (c *WorkSpaces) UpdateWorkspaceImagePermission(input *UpdateWorkspaceImagePermissionInput) (*UpdateWorkspaceImagePermissionOutput, error)

UpdateWorkspaceImagePermission API operation for Amazon WorkSpaces.

Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.

After an image has been shared, the recipient account can copy the image to other Regions as needed.

In the China (Ningxia) Region, you can copy images only within the same Region.

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html).

  • To delete an image that has been shared, you must unshare the image before you delete it.

  • Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon WorkSpaces's API operation UpdateWorkspaceImagePermission for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The resource could not be found.

  • ResourceUnavailableException The specified resource is not available.

  • AccessDeniedException The user is not authorized to access a resource.

  • InvalidParameterValuesException One or more parameter values are not valid.

  • OperationNotSupportedException This operation is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceImagePermission

func (*WorkSpaces) UpdateWorkspaceImagePermissionRequest added in v1.33.11 

func (c *WorkSpaces) UpdateWorkspaceImagePermissionRequest(input *UpdateWorkspaceImagePermissionInput) (req *request.Request, output *UpdateWorkspaceImagePermissionOutput)

UpdateWorkspaceImagePermissionRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkspaceImagePermission operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkspaceImagePermission for more information on using the UpdateWorkspaceImagePermission API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateWorkspaceImagePermissionRequest method.
req, resp := client.UpdateWorkspaceImagePermissionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceImagePermission

func (*WorkSpaces) UpdateWorkspaceImagePermissionWithContext added in v1.33.11 

func (c *WorkSpaces) UpdateWorkspaceImagePermissionWithContext(ctx aws.Context, input *UpdateWorkspaceImagePermissionInput, opts ...request.Option) (*UpdateWorkspaceImagePermissionOutput, error)

UpdateWorkspaceImagePermissionWithContext is the same as UpdateWorkspaceImagePermission with the addition of the ability to pass a context and additional request options.

See UpdateWorkspaceImagePermission for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Workspace 

type Workspace struct {

	// The identifier of the bundle used to create the WorkSpace.
	BundleId *string `type:"string"`

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

	// Indicates the settings of the data replication.
	DataReplicationSettings *DataReplicationSettings `type:"structure"`

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

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

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

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

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

	// The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
	RelatedWorkspaces []*RelatedWorkspaceProperties `type:"list"`

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

	// The properties of the standby WorkSpace
	StandbyWorkspacesProperties []*StandbyWorkspacesProperties `type:"list"`

	// 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 (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html).
	// If the WorkSpace ID isn't returned, then the WorkSpace has been successfully
	// terminated.
	State *string `type:"string" enum:"WorkspaceState"`

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

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

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

	// The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
	// Amazon WorkSpaces does not support asymmetric KMS keys.
	VolumeEncryptionKey *string `type:"string"`

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

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

Describes a WorkSpace.

func (Workspace) GoString added in v0.6.5 

func (s Workspace) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Workspace) SetBundleId added in v1.5.0 

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

SetBundleId sets the BundleId field's value.

func (*Workspace) SetComputerName added in v1.5.0 

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

SetComputerName sets the ComputerName field's value.

func (*Workspace) SetDataReplicationSettings added in v1.48.4 

func (s *Workspace) SetDataReplicationSettings(v *DataReplicationSettings) *Workspace

SetDataReplicationSettings sets the DataReplicationSettings field's value.

func (*Workspace) SetDirectoryId added in v1.5.0 

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

SetDirectoryId sets the DirectoryId field's value.

func (*Workspace) SetErrorCode added in v1.5.0 

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

SetErrorCode sets the ErrorCode field's value.

func (*Workspace) SetErrorMessage added in v1.5.0 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*Workspace) SetIpAddress added in v1.5.0 

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

SetIpAddress sets the IpAddress field's value.

func (*Workspace) SetModificationStates added in v1.12.54 

func (s *Workspace) SetModificationStates(v []*ModificationState) *Workspace

SetModificationStates sets the ModificationStates field's value.

func (*Workspace) SetRelatedWorkspaces added in v1.44.140 

func (s *Workspace) SetRelatedWorkspaces(v []*RelatedWorkspaceProperties) *Workspace

SetRelatedWorkspaces sets the RelatedWorkspaces field's value.

func (*Workspace) SetRootVolumeEncryptionEnabled added in v1.5.0 

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

SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.

func (*Workspace) SetStandbyWorkspacesProperties added in v1.48.4 

func (s *Workspace) SetStandbyWorkspacesProperties(v []*StandbyWorkspacesProperties) *Workspace

SetStandbyWorkspacesProperties sets the StandbyWorkspacesProperties field's value.

func (*Workspace) SetState added in v1.5.0 

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

SetState sets the State field's value.

func (*Workspace) SetSubnetId added in v1.5.0 

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

SetSubnetId sets the SubnetId field's value.

func (*Workspace) SetUserName added in v1.5.0 

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

SetUserName sets the UserName field's value.

func (*Workspace) SetUserVolumeEncryptionEnabled added in v1.5.0 

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

SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.

func (*Workspace) SetVolumeEncryptionKey added in v1.5.0 

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

SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.

func (*Workspace) SetWorkspaceId added in v1.5.0 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (*Workspace) SetWorkspaceProperties added in v1.5.0 

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

SetWorkspaceProperties sets the WorkspaceProperties field's value.

func (Workspace) String added in v0.6.5 

func (s Workspace) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceAccessProperties added in v1.25.36 

type WorkspaceAccessProperties struct {

	// Indicates whether users can use Android and Android-compatible Chrome OS
	// devices to access their WorkSpaces.
	DeviceTypeAndroid *string `type:"string" enum:"AccessPropertyValue"`

	// Indicates whether users can use Chromebooks to access their WorkSpaces.
	DeviceTypeChromeOs *string `type:"string" enum:"AccessPropertyValue"`

	// Indicates whether users can use iOS devices to access their WorkSpaces.
	DeviceTypeIos *string `type:"string" enum:"AccessPropertyValue"`

	// Indicates whether users can use Linux clients to access their WorkSpaces.
	DeviceTypeLinux *string `type:"string" enum:"AccessPropertyValue"`

	// Indicates whether users can use macOS clients to access their WorkSpaces.
	DeviceTypeOsx *string `type:"string" enum:"AccessPropertyValue"`

	// Indicates whether users can access their WorkSpaces through a web browser.
	DeviceTypeWeb *string `type:"string" enum:"AccessPropertyValue"`

	// Indicates whether users can use Windows clients to access their WorkSpaces.
	DeviceTypeWindows *string `type:"string" enum:"AccessPropertyValue"`

	// Indicates whether users can use zero client devices to access their WorkSpaces.
	DeviceTypeZeroClient *string `type:"string" enum:"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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-network-requirements.html).

func (WorkspaceAccessProperties) GoString added in v1.25.36 

func (s WorkspaceAccessProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceAccessProperties) SetDeviceTypeAndroid added in v1.25.36 

func (s *WorkspaceAccessProperties) SetDeviceTypeAndroid(v string) *WorkspaceAccessProperties

SetDeviceTypeAndroid sets the DeviceTypeAndroid field's value.

func (*WorkspaceAccessProperties) SetDeviceTypeChromeOs added in v1.25.36 

func (s *WorkspaceAccessProperties) SetDeviceTypeChromeOs(v string) *WorkspaceAccessProperties

SetDeviceTypeChromeOs sets the DeviceTypeChromeOs field's value.

func (*WorkspaceAccessProperties) SetDeviceTypeIos added in v1.25.36 

func (s *WorkspaceAccessProperties) SetDeviceTypeIos(v string) *WorkspaceAccessProperties

SetDeviceTypeIos sets the DeviceTypeIos field's value.

func (*WorkspaceAccessProperties) SetDeviceTypeLinux added in v1.38.47 

func (s *WorkspaceAccessProperties) SetDeviceTypeLinux(v string) *WorkspaceAccessProperties

SetDeviceTypeLinux sets the DeviceTypeLinux field's value.

func (*WorkspaceAccessProperties) SetDeviceTypeOsx added in v1.25.36 

func (s *WorkspaceAccessProperties) SetDeviceTypeOsx(v string) *WorkspaceAccessProperties

SetDeviceTypeOsx sets the DeviceTypeOsx field's value.

func (*WorkspaceAccessProperties) SetDeviceTypeWeb added in v1.25.36 

func (s *WorkspaceAccessProperties) SetDeviceTypeWeb(v string) *WorkspaceAccessProperties

SetDeviceTypeWeb sets the DeviceTypeWeb field's value.

func (*WorkspaceAccessProperties) SetDeviceTypeWindows added in v1.25.36 

func (s *WorkspaceAccessProperties) SetDeviceTypeWindows(v string) *WorkspaceAccessProperties

SetDeviceTypeWindows sets the DeviceTypeWindows field's value.

func (*WorkspaceAccessProperties) SetDeviceTypeZeroClient added in v1.25.36 

func (s *WorkspaceAccessProperties) SetDeviceTypeZeroClient(v string) *WorkspaceAccessProperties

SetDeviceTypeZeroClient sets the DeviceTypeZeroClient field's value.

func (WorkspaceAccessProperties) String added in v1.25.36 

func (s WorkspaceAccessProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceBundle 

type WorkspaceBundle struct {

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

	// The type of WorkSpace bundle.
	BundleType *string `type:"string" enum:"BundleType"`

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

	// The time when the bundle was created.
	CreationTime *time.Time `type:"timestamp"`

	// The description of the bundle.
	Description *string `type:"string"`

	// The identifier of the image that was used to create the bundle.
	ImageId *string `type:"string"`

	// The last time that the bundle was updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

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

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

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

	// The state of the WorkSpace bundle.
	State *string `type:"string" enum:"WorkspaceBundleState"`

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

Describes a WorkSpace bundle.

func (WorkspaceBundle) GoString added in v0.6.5 

func (s WorkspaceBundle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceBundle) SetBundleId added in v1.5.0 

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

SetBundleId sets the BundleId field's value.

func (*WorkspaceBundle) SetBundleType added in v1.44.140 

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

SetBundleType sets the BundleType field's value.

func (*WorkspaceBundle) SetComputeType added in v1.5.0 

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

SetComputeType sets the ComputeType field's value.

func (*WorkspaceBundle) SetCreationTime added in v1.37.30 

func (s *WorkspaceBundle) SetCreationTime(v time.Time) *WorkspaceBundle

SetCreationTime sets the CreationTime field's value.

func (*WorkspaceBundle) SetDescription added in v1.5.0 

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

SetDescription sets the Description field's value.

func (*WorkspaceBundle) SetImageId added in v1.25.43 

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

SetImageId sets the ImageId field's value.

func (*WorkspaceBundle) SetLastUpdatedTime added in v1.25.43 

func (s *WorkspaceBundle) SetLastUpdatedTime(v time.Time) *WorkspaceBundle

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*WorkspaceBundle) SetName added in v1.5.0 

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

SetName sets the Name field's value.

func (*WorkspaceBundle) SetOwner added in v1.5.0 

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

SetOwner sets the Owner field's value.

func (*WorkspaceBundle) SetRootStorage added in v1.12.54 

func (s *WorkspaceBundle) SetRootStorage(v *RootStorage) *WorkspaceBundle

SetRootStorage sets the RootStorage field's value.

func (*WorkspaceBundle) SetState added in v1.44.140 

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

SetState sets the State field's value.

func (*WorkspaceBundle) SetUserStorage added in v1.5.0 

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

SetUserStorage sets the UserStorage field's value.

func (WorkspaceBundle) String added in v0.6.5 

func (s WorkspaceBundle) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceConnectionStatus added in v1.4.3 

type WorkspaceConnectionStatus struct {

	// The connection state of the WorkSpace. The connection state is unknown if
	// the WorkSpace is stopped.
	ConnectionState *string `type:"string" enum:"ConnectionState"`

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

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

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

Describes the connection status of a WorkSpace.

func (WorkspaceConnectionStatus) GoString added in v1.4.3 

func (s WorkspaceConnectionStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceConnectionStatus) SetConnectionState added in v1.5.0 

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

SetConnectionState sets the ConnectionState field's value.

func (*WorkspaceConnectionStatus) SetConnectionStateCheckTimestamp added in v1.5.0 

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

SetConnectionStateCheckTimestamp sets the ConnectionStateCheckTimestamp field's value.

func (*WorkspaceConnectionStatus) SetLastKnownUserConnectionTimestamp added in v1.5.0 

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

SetLastKnownUserConnectionTimestamp sets the LastKnownUserConnectionTimestamp field's value.

func (*WorkspaceConnectionStatus) SetWorkspaceId added in v1.5.0 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (WorkspaceConnectionStatus) String added in v1.4.3 

func (s WorkspaceConnectionStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceCreationProperties added in v1.25.36 

type WorkspaceCreationProperties struct {

	// The identifier of your custom security group.
	CustomSecurityGroupId *string `min:"11" type:"string"`

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

	// Indicates whether internet access is enabled for your WorkSpaces.
	EnableInternetAccess *bool `type:"boolean"`

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

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

	// Indicates whether users are local administrators of their WorkSpaces.
	UserEnabledAsLocalAdministrator *bool `type:"boolean"`
	// 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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html).

func (WorkspaceCreationProperties) GoString added in v1.25.36 

func (s WorkspaceCreationProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceCreationProperties) SetCustomSecurityGroupId added in v1.25.36 

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

SetCustomSecurityGroupId sets the CustomSecurityGroupId field's value.

func (*WorkspaceCreationProperties) SetDefaultOu added in v1.25.36 

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

SetDefaultOu sets the DefaultOu field's value.

func (*WorkspaceCreationProperties) SetEnableInternetAccess added in v1.25.36 

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

SetEnableInternetAccess sets the EnableInternetAccess field's value.

func (*WorkspaceCreationProperties) SetEnableMaintenanceMode added in v1.25.36 

func (s *WorkspaceCreationProperties) SetEnableMaintenanceMode(v bool) *WorkspaceCreationProperties

SetEnableMaintenanceMode sets the EnableMaintenanceMode field's value.

func (*WorkspaceCreationProperties) SetEnableWorkDocs added in v1.34.3 

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

SetEnableWorkDocs sets the EnableWorkDocs field's value.

func (*WorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator added in v1.25.36 

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

SetUserEnabledAsLocalAdministrator sets the UserEnabledAsLocalAdministrator field's value.

func (WorkspaceCreationProperties) String added in v1.25.36 

func (s WorkspaceCreationProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceCreationProperties) Validate added in v1.25.36 

func (s *WorkspaceCreationProperties) Validate() error

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

type WorkspaceDirectory 

type WorkspaceDirectory struct {

	// The directory alias.
	Alias *string `type:"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 `type:"structure"`

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

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

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

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

	// The IP addresses of the DNS servers for the directory.
	DnsIpAddresses []*string `type:"list"`

	// The identifier of the IAM role. This is the role that allows Amazon WorkSpaces
	// to make calls to other services, such as Amazon EC2, on your behalf.
	IamRoleId *string `type:"string"`

	// The identifiers of the IP access control groups associated with the directory.
	IpGroupIds []*string `locationName:"ipGroupIds" type:"list"`

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

	// 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 `type:"structure"`

	// The default self-service permissions for WorkSpaces in the directory.
	SelfservicePermissions *SelfservicePermissions `type:"structure"`

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

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

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

	// The devices and operating systems that users can use to access WorkSpaces.
	WorkspaceAccessProperties *WorkspaceAccessProperties `type:"structure"`

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

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

Describes a directory that is used with Amazon WorkSpaces.

func (WorkspaceDirectory) GoString added in v0.6.5 

func (s WorkspaceDirectory) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceDirectory) SetAlias added in v1.5.0 

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

SetAlias sets the Alias field's value.

func (*WorkspaceDirectory) SetCertificateBasedAuthProperties added in v1.44.138 

func (s *WorkspaceDirectory) SetCertificateBasedAuthProperties(v *CertificateBasedAuthProperties) *WorkspaceDirectory

SetCertificateBasedAuthProperties sets the CertificateBasedAuthProperties field's value.

func (*WorkspaceDirectory) SetCustomerUserName added in v1.5.0 

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

SetCustomerUserName sets the CustomerUserName field's value.

func (*WorkspaceDirectory) SetDirectoryId added in v1.5.0 

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

SetDirectoryId sets the DirectoryId field's value.

func (*WorkspaceDirectory) SetDirectoryName added in v1.5.0 

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

SetDirectoryName sets the DirectoryName field's value.

func (*WorkspaceDirectory) SetDirectoryType added in v1.5.0 

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

SetDirectoryType sets the DirectoryType field's value.

func (*WorkspaceDirectory) SetDnsIpAddresses added in v1.5.0 

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

SetDnsIpAddresses sets the DnsIpAddresses field's value.

func (*WorkspaceDirectory) SetIamRoleId added in v1.5.0 

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

SetIamRoleId sets the IamRoleId field's value.

func (*WorkspaceDirectory) SetIpGroupIds added in v1.13.39 

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

SetIpGroupIds sets the IpGroupIds field's value.

func (*WorkspaceDirectory) SetRegistrationCode added in v1.5.0 

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

SetRegistrationCode sets the RegistrationCode field's value.

func (*WorkspaceDirectory) SetSamlProperties added in v1.44.67 

func (s *WorkspaceDirectory) SetSamlProperties(v *SamlProperties) *WorkspaceDirectory

SetSamlProperties sets the SamlProperties field's value.

func (*WorkspaceDirectory) SetSelfservicePermissions added in v1.25.36 

func (s *WorkspaceDirectory) SetSelfservicePermissions(v *SelfservicePermissions) *WorkspaceDirectory

SetSelfservicePermissions sets the SelfservicePermissions field's value.

func (*WorkspaceDirectory) SetState added in v1.5.0 

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

SetState sets the State field's value.

func (*WorkspaceDirectory) SetSubnetIds added in v1.5.0 

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

SetSubnetIds sets the SubnetIds field's value.

func (*WorkspaceDirectory) SetTenancy added in v1.25.36 

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

SetTenancy sets the Tenancy field's value.

func (*WorkspaceDirectory) SetWorkspaceAccessProperties added in v1.25.36 

func (s *WorkspaceDirectory) SetWorkspaceAccessProperties(v *WorkspaceAccessProperties) *WorkspaceDirectory

SetWorkspaceAccessProperties sets the WorkspaceAccessProperties field's value.

func (*WorkspaceDirectory) SetWorkspaceCreationProperties added in v1.5.0 

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

SetWorkspaceCreationProperties sets the WorkspaceCreationProperties field's value.

func (*WorkspaceDirectory) SetWorkspaceSecurityGroupId added in v1.5.0 

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

SetWorkspaceSecurityGroupId sets the WorkspaceSecurityGroupId field's value.

func (WorkspaceDirectory) String added in v0.6.5 

func (s WorkspaceDirectory) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceImage added in v1.15.78 

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 `type:"timestamp"`

	// The description of the image.
	Description *string `min:"1" type:"string"`

	// The error code that is returned for the image.
	ErrorCode *string `type:"string"`

	// Additional details of the error returned for the image, including the possible
	// causes of the errors and troubleshooting information.
	ErrorDetails []*ErrorDetails `type:"list"`

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

	// The identifier of the image.
	ImageId *string `type:"string"`

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

	// The operating system that the image is running.
	OperatingSystem *OperatingSystem `type:"structure"`

	// The identifier of the Amazon Web Services account that owns the image.
	OwnerAccountId *string `type:"string"`

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

	// The status of the image.
	State *string `type:"string" enum:"WorkspaceImageState"`

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

Describes a WorkSpace image.

func (WorkspaceImage) GoString added in v1.15.78 

func (s WorkspaceImage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceImage) SetCreated added in v1.33.11 

func (s *WorkspaceImage) SetCreated(v time.Time) *WorkspaceImage

SetCreated sets the Created field's value.

func (*WorkspaceImage) SetDescription added in v1.15.78 

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

SetDescription sets the Description field's value.

func (*WorkspaceImage) SetErrorCode added in v1.15.78 

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

SetErrorCode sets the ErrorCode field's value.

func (*WorkspaceImage) SetErrorDetails added in v1.45.6 

func (s *WorkspaceImage) SetErrorDetails(v []*ErrorDetails) *WorkspaceImage

SetErrorDetails sets the ErrorDetails field's value.

func (*WorkspaceImage) SetErrorMessage added in v1.15.78 

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

SetErrorMessage sets the ErrorMessage field's value.

func (*WorkspaceImage) SetImageId added in v1.15.78 

func (s *WorkspaceImage) SetImageId(v string) *WorkspaceImage

SetImageId sets the ImageId field's value.

func (*WorkspaceImage) SetName added in v1.15.78 

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

SetName sets the Name field's value.

func (*WorkspaceImage) SetOperatingSystem added in v1.15.78 

func (s *WorkspaceImage) SetOperatingSystem(v *OperatingSystem) *WorkspaceImage

SetOperatingSystem sets the OperatingSystem field's value.

func (*WorkspaceImage) SetOwnerAccountId added in v1.33.11 

func (s *WorkspaceImage) SetOwnerAccountId(v string) *WorkspaceImage

SetOwnerAccountId sets the OwnerAccountId field's value.

func (*WorkspaceImage) SetRequiredTenancy added in v1.15.78 

func (s *WorkspaceImage) SetRequiredTenancy(v string) *WorkspaceImage

SetRequiredTenancy sets the RequiredTenancy field's value.

func (*WorkspaceImage) SetState added in v1.15.78 

func (s *WorkspaceImage) SetState(v string) *WorkspaceImage

SetState sets the State field's value.

func (*WorkspaceImage) SetUpdates added in v1.40.53 

func (s *WorkspaceImage) SetUpdates(v *UpdateResult) *WorkspaceImage

SetUpdates sets the Updates field's value.

func (WorkspaceImage) String added in v1.15.78 

func (s WorkspaceImage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceProperties added in v1.4.3 

type WorkspaceProperties struct {

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

	// The name of the operating system.
	OperatingSystemName *string `type:"string" enum:"OperatingSystemName"`

	// The protocol. For more information, see Protocols for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-protocols.html).
	//
	//    * 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 []*string `type:"list" enum:"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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html).
	RootVolumeSizeGib *int64 `type:"integer"`

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

	// The time after a user logs off when WorkSpaces are automatically stopped.
	// Configured in 60-minute intervals.
	RunningModeAutoStopTimeoutInMinutes *int64 `type:"integer"`

	// The size of the user storage. For important information about how to modify
	// the size of the root and user volumes, see Modify a WorkSpace (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html).
	UserVolumeSizeGib *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Describes a WorkSpace.

func (WorkspaceProperties) GoString added in v1.4.3 

func (s WorkspaceProperties) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceProperties) SetComputeTypeName added in v1.12.54 

func (s *WorkspaceProperties) SetComputeTypeName(v string) *WorkspaceProperties

SetComputeTypeName sets the ComputeTypeName field's value.

func (*WorkspaceProperties) SetOperatingSystemName added in v1.45.23 

func (s *WorkspaceProperties) SetOperatingSystemName(v string) *WorkspaceProperties

SetOperatingSystemName sets the OperatingSystemName field's value.

func (*WorkspaceProperties) SetProtocols added in v1.44.132 

func (s *WorkspaceProperties) SetProtocols(v []*string) *WorkspaceProperties

SetProtocols sets the Protocols field's value.

func (*WorkspaceProperties) SetRootVolumeSizeGib added in v1.12.54 

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

SetRootVolumeSizeGib sets the RootVolumeSizeGib field's value.

func (*WorkspaceProperties) SetRunningMode added in v1.5.0 

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

SetRunningMode sets the RunningMode field's value.

func (*WorkspaceProperties) SetRunningModeAutoStopTimeoutInMinutes added in v1.5.0 

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

SetRunningModeAutoStopTimeoutInMinutes sets the RunningModeAutoStopTimeoutInMinutes field's value.

func (*WorkspaceProperties) SetUserVolumeSizeGib added in v1.12.54 

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

SetUserVolumeSizeGib sets the UserVolumeSizeGib field's value.

func (WorkspaceProperties) String added in v1.4.3 

func (s WorkspaceProperties) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceRequest 

type WorkspaceRequest struct {

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

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

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

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

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

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

	// The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
	// Amazon WorkSpaces does not support asymmetric KMS keys.
	VolumeEncryptionKey *string `type:"string"`

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

Describes the information used to create a WorkSpace.

func (WorkspaceRequest) GoString added in v0.6.5 

func (s WorkspaceRequest) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceRequest) SetBundleId added in v1.5.0 

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

SetBundleId sets the BundleId field's value.

func (*WorkspaceRequest) SetDirectoryId added in v1.5.0 

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

SetDirectoryId sets the DirectoryId field's value.

func (*WorkspaceRequest) SetRootVolumeEncryptionEnabled added in v1.5.0 

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

SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.

func (*WorkspaceRequest) SetTags added in v1.5.0 

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

SetTags sets the Tags field's value.

func (*WorkspaceRequest) SetUserName added in v1.5.0 

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

SetUserName sets the UserName field's value.

func (*WorkspaceRequest) SetUserVolumeEncryptionEnabled added in v1.5.0 

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

SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.

func (*WorkspaceRequest) SetVolumeEncryptionKey added in v1.5.0 

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

SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.

func (*WorkspaceRequest) SetWorkspaceProperties added in v1.5.0 

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

SetWorkspaceProperties sets the WorkspaceProperties field's value.

func (WorkspaceRequest) String added in v0.6.5 

func (s WorkspaceRequest) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceRequest) Validate added in v1.1.21 

func (s *WorkspaceRequest) Validate() error

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

type WorkspaceResourceAssociation added in v1.45.23 

type WorkspaceResourceAssociation struct {

	// The identifier of the associated resource.
	AssociatedResourceId *string `min:"1" type:"string"`

	// The resource types of the associated resource.
	AssociatedResourceType *string `type:"string" enum:"WorkSpaceAssociatedResourceType"`

	// The time the association is created.
	Created *time.Time `type:"timestamp"`

	// The time the association status was last updated.
	LastUpdatedTime *time.Time `type:"timestamp"`

	// The status of the WorkSpace resource association.
	State *string `type:"string" enum:"AssociationState"`

	// The reason the association deployment failed.
	StateReason *AssociationStateReason `type:"structure"`

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

Describes the association between an application and a WorkSpace resource.

func (WorkspaceResourceAssociation) GoString added in v1.45.23 

func (s WorkspaceResourceAssociation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceResourceAssociation) SetAssociatedResourceId added in v1.45.23 

func (s *WorkspaceResourceAssociation) SetAssociatedResourceId(v string) *WorkspaceResourceAssociation

SetAssociatedResourceId sets the AssociatedResourceId field's value.

func (*WorkspaceResourceAssociation) SetAssociatedResourceType added in v1.45.23 

func (s *WorkspaceResourceAssociation) SetAssociatedResourceType(v string) *WorkspaceResourceAssociation

SetAssociatedResourceType sets the AssociatedResourceType field's value.

func (*WorkspaceResourceAssociation) SetCreated added in v1.45.23 

func (s *WorkspaceResourceAssociation) SetCreated(v time.Time) *WorkspaceResourceAssociation

SetCreated sets the Created field's value.

func (*WorkspaceResourceAssociation) SetLastUpdatedTime added in v1.45.23 

func (s *WorkspaceResourceAssociation) SetLastUpdatedTime(v time.Time) *WorkspaceResourceAssociation

SetLastUpdatedTime sets the LastUpdatedTime field's value.

func (*WorkspaceResourceAssociation) SetState added in v1.45.23 

func (s *WorkspaceResourceAssociation) SetState(v string) *WorkspaceResourceAssociation

SetState sets the State field's value.

func (*WorkspaceResourceAssociation) SetStateReason added in v1.45.23 

func (s *WorkspaceResourceAssociation) SetStateReason(v *AssociationStateReason) *WorkspaceResourceAssociation

SetStateReason sets the StateReason field's value.

func (*WorkspaceResourceAssociation) SetWorkspaceId added in v1.45.23 

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

SetWorkspaceId sets the WorkspaceId field's value.

func (WorkspaceResourceAssociation) String added in v1.45.23 

func (s WorkspaceResourceAssociation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspacesDefaultRoleNotFoundException added in v1.28.0 

type WorkspacesDefaultRoleNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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 (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role).

func (*WorkspacesDefaultRoleNotFoundException) Code added in v1.28.0 

func (s *WorkspacesDefaultRoleNotFoundException) Code() string

Code returns the exception type name.

func (*WorkspacesDefaultRoleNotFoundException) Error added in v1.28.0 

func (s *WorkspacesDefaultRoleNotFoundException) Error() string

func (WorkspacesDefaultRoleNotFoundException) GoString added in v1.28.0 

func (s WorkspacesDefaultRoleNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspacesDefaultRoleNotFoundException) Message added in v1.28.0 

func (s *WorkspacesDefaultRoleNotFoundException) Message() string

Message returns the exception's message.

func (*WorkspacesDefaultRoleNotFoundException) OrigErr added in v1.28.0 

func (s *WorkspacesDefaultRoleNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*WorkspacesDefaultRoleNotFoundException) RequestID added in v1.28.0 

func (s *WorkspacesDefaultRoleNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*WorkspacesDefaultRoleNotFoundException) StatusCode added in v1.28.0 

func (s *WorkspacesDefaultRoleNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (WorkspacesDefaultRoleNotFoundException) String added in v1.28.0 

func (s WorkspacesDefaultRoleNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package workspacesiface provides an interface to enable mocking the Amazon WorkSpaces service client for testing your code.
 Package workspacesiface provides an interface to enable mocking the Amazon WorkSpaces service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.