package workspaces
import "github.com/aws/aws-sdk-go-v2/service/workspaces"
Package workspaces provides the API client, operations, and parameter types for Amazon WorkSpaces.
Amazon WorkSpaces Service Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type AssociateIpGroupsInput
- type AssociateIpGroupsOutput
- type AuthorizeIpRulesInput
- type AuthorizeIpRulesOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) AssociateIpGroups(ctx context.Context, params *AssociateIpGroupsInput, optFns ...func(*Options)) (*AssociateIpGroupsOutput, error)
- func (c *Client) AuthorizeIpRules(ctx context.Context, params *AuthorizeIpRulesInput, optFns ...func(*Options)) (*AuthorizeIpRulesOutput, error)
- func (c *Client) CopyWorkspaceImage(ctx context.Context, params *CopyWorkspaceImageInput, optFns ...func(*Options)) (*CopyWorkspaceImageOutput, error)
- func (c *Client) CreateIpGroup(ctx context.Context, params *CreateIpGroupInput, optFns ...func(*Options)) (*CreateIpGroupOutput, error)
- func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns ...func(*Options)) (*CreateTagsOutput, error)
- func (c *Client) CreateWorkspaces(ctx context.Context, params *CreateWorkspacesInput, optFns ...func(*Options)) (*CreateWorkspacesOutput, error)
- func (c *Client) DeleteIpGroup(ctx context.Context, params *DeleteIpGroupInput, optFns ...func(*Options)) (*DeleteIpGroupOutput, error)
- func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns ...func(*Options)) (*DeleteTagsOutput, error)
- func (c *Client) DeleteWorkspaceImage(ctx context.Context, params *DeleteWorkspaceImageInput, optFns ...func(*Options)) (*DeleteWorkspaceImageOutput, error)
- func (c *Client) DeregisterWorkspaceDirectory(ctx context.Context, params *DeregisterWorkspaceDirectoryInput, optFns ...func(*Options)) (*DeregisterWorkspaceDirectoryOutput, error)
- func (c *Client) DescribeAccount(ctx context.Context, params *DescribeAccountInput, optFns ...func(*Options)) (*DescribeAccountOutput, error)
- func (c *Client) DescribeAccountModifications(ctx context.Context, params *DescribeAccountModificationsInput, optFns ...func(*Options)) (*DescribeAccountModificationsOutput, error)
- func (c *Client) DescribeClientProperties(ctx context.Context, params *DescribeClientPropertiesInput, optFns ...func(*Options)) (*DescribeClientPropertiesOutput, error)
- func (c *Client) DescribeIpGroups(ctx context.Context, params *DescribeIpGroupsInput, optFns ...func(*Options)) (*DescribeIpGroupsOutput, error)
- func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, optFns ...func(*Options)) (*DescribeTagsOutput, error)
- func (c *Client) DescribeWorkspaceBundles(ctx context.Context, params *DescribeWorkspaceBundlesInput, optFns ...func(*Options)) (*DescribeWorkspaceBundlesOutput, error)
- func (c *Client) DescribeWorkspaceDirectories(ctx context.Context, params *DescribeWorkspaceDirectoriesInput, optFns ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error)
- func (c *Client) DescribeWorkspaceImagePermissions(ctx context.Context, params *DescribeWorkspaceImagePermissionsInput, optFns ...func(*Options)) (*DescribeWorkspaceImagePermissionsOutput, error)
- func (c *Client) DescribeWorkspaceImages(ctx context.Context, params *DescribeWorkspaceImagesInput, optFns ...func(*Options)) (*DescribeWorkspaceImagesOutput, error)
- func (c *Client) DescribeWorkspaceSnapshots(ctx context.Context, params *DescribeWorkspaceSnapshotsInput, optFns ...func(*Options)) (*DescribeWorkspaceSnapshotsOutput, error)
- func (c *Client) DescribeWorkspaces(ctx context.Context, params *DescribeWorkspacesInput, optFns ...func(*Options)) (*DescribeWorkspacesOutput, error)
- func (c *Client) DescribeWorkspacesConnectionStatus(ctx context.Context, params *DescribeWorkspacesConnectionStatusInput, optFns ...func(*Options)) (*DescribeWorkspacesConnectionStatusOutput, error)
- func (c *Client) DisassociateIpGroups(ctx context.Context, params *DisassociateIpGroupsInput, optFns ...func(*Options)) (*DisassociateIpGroupsOutput, error)
- func (c *Client) ImportWorkspaceImage(ctx context.Context, params *ImportWorkspaceImageInput, optFns ...func(*Options)) (*ImportWorkspaceImageOutput, error)
- func (c *Client) ListAvailableManagementCidrRanges(ctx context.Context, params *ListAvailableManagementCidrRangesInput, optFns ...func(*Options)) (*ListAvailableManagementCidrRangesOutput, error)
- func (c *Client) MigrateWorkspace(ctx context.Context, params *MigrateWorkspaceInput, optFns ...func(*Options)) (*MigrateWorkspaceOutput, error)
- func (c *Client) ModifyAccount(ctx context.Context, params *ModifyAccountInput, optFns ...func(*Options)) (*ModifyAccountOutput, error)
- func (c *Client) ModifyClientProperties(ctx context.Context, params *ModifyClientPropertiesInput, optFns ...func(*Options)) (*ModifyClientPropertiesOutput, error)
- func (c *Client) ModifySelfservicePermissions(ctx context.Context, params *ModifySelfservicePermissionsInput, optFns ...func(*Options)) (*ModifySelfservicePermissionsOutput, error)
- func (c *Client) ModifyWorkspaceAccessProperties(ctx context.Context, params *ModifyWorkspaceAccessPropertiesInput, optFns ...func(*Options)) (*ModifyWorkspaceAccessPropertiesOutput, error)
- func (c *Client) ModifyWorkspaceCreationProperties(ctx context.Context, params *ModifyWorkspaceCreationPropertiesInput, optFns ...func(*Options)) (*ModifyWorkspaceCreationPropertiesOutput, error)
- func (c *Client) ModifyWorkspaceProperties(ctx context.Context, params *ModifyWorkspacePropertiesInput, optFns ...func(*Options)) (*ModifyWorkspacePropertiesOutput, error)
- func (c *Client) ModifyWorkspaceState(ctx context.Context, params *ModifyWorkspaceStateInput, optFns ...func(*Options)) (*ModifyWorkspaceStateOutput, error)
- func (c *Client) RebootWorkspaces(ctx context.Context, params *RebootWorkspacesInput, optFns ...func(*Options)) (*RebootWorkspacesOutput, error)
- func (c *Client) RebuildWorkspaces(ctx context.Context, params *RebuildWorkspacesInput, optFns ...func(*Options)) (*RebuildWorkspacesOutput, error)
- func (c *Client) RegisterWorkspaceDirectory(ctx context.Context, params *RegisterWorkspaceDirectoryInput, optFns ...func(*Options)) (*RegisterWorkspaceDirectoryOutput, error)
- func (c *Client) RestoreWorkspace(ctx context.Context, params *RestoreWorkspaceInput, optFns ...func(*Options)) (*RestoreWorkspaceOutput, error)
- func (c *Client) RevokeIpRules(ctx context.Context, params *RevokeIpRulesInput, optFns ...func(*Options)) (*RevokeIpRulesOutput, error)
- func (c *Client) StartWorkspaces(ctx context.Context, params *StartWorkspacesInput, optFns ...func(*Options)) (*StartWorkspacesOutput, error)
- func (c *Client) StopWorkspaces(ctx context.Context, params *StopWorkspacesInput, optFns ...func(*Options)) (*StopWorkspacesOutput, error)
- func (c *Client) TerminateWorkspaces(ctx context.Context, params *TerminateWorkspacesInput, optFns ...func(*Options)) (*TerminateWorkspacesOutput, error)
- func (c *Client) UpdateRulesOfIpGroup(ctx context.Context, params *UpdateRulesOfIpGroupInput, optFns ...func(*Options)) (*UpdateRulesOfIpGroupOutput, error)
- func (c *Client) UpdateWorkspaceImagePermission(ctx context.Context, params *UpdateWorkspaceImagePermissionInput, optFns ...func(*Options)) (*UpdateWorkspaceImagePermissionOutput, error)
- type CopyWorkspaceImageInput
- type CopyWorkspaceImageOutput
- type CreateIpGroupInput
- type CreateIpGroupOutput
- type CreateTagsInput
- type CreateTagsOutput
- type CreateWorkspacesInput
- type CreateWorkspacesOutput
- type DeleteIpGroupInput
- type DeleteIpGroupOutput
- type DeleteTagsInput
- type DeleteTagsOutput
- type DeleteWorkspaceImageInput
- type DeleteWorkspaceImageOutput
- type DeregisterWorkspaceDirectoryInput
- type DeregisterWorkspaceDirectoryOutput
- type DescribeAccountInput
- type DescribeAccountModificationsInput
- type DescribeAccountModificationsOutput
- type DescribeAccountOutput
- type DescribeClientPropertiesInput
- type DescribeClientPropertiesOutput
- type DescribeIpGroupsInput
- type DescribeIpGroupsOutput
- type DescribeTagsInput
- type DescribeTagsOutput
- type DescribeWorkspaceBundlesInput
- type DescribeWorkspaceBundlesOutput
- type DescribeWorkspaceDirectoriesInput
- type DescribeWorkspaceDirectoriesOutput
- type DescribeWorkspaceImagePermissionsInput
- type DescribeWorkspaceImagePermissionsOutput
- type DescribeWorkspaceImagesInput
- type DescribeWorkspaceImagesOutput
- type DescribeWorkspaceSnapshotsInput
- type DescribeWorkspaceSnapshotsOutput
- type DescribeWorkspacesConnectionStatusInput
- type DescribeWorkspacesConnectionStatusOutput
- type DescribeWorkspacesInput
- type DescribeWorkspacesOutput
- type DisassociateIpGroupsInput
- type DisassociateIpGroupsOutput
- type EndpointResolver
- type EndpointResolverFunc
- type HTTPClient
- type HTTPSignerV4
- type ImportWorkspaceImageInput
- type ImportWorkspaceImageOutput
- type ListAvailableManagementCidrRangesInput
- type ListAvailableManagementCidrRangesOutput
- type MigrateWorkspaceInput
- type MigrateWorkspaceOutput
- type ModifyAccountInput
- type ModifyAccountOutput
- type ModifyClientPropertiesInput
- type ModifyClientPropertiesOutput
- type ModifySelfservicePermissionsInput
- type ModifySelfservicePermissionsOutput
- type ModifyWorkspaceAccessPropertiesInput
- type ModifyWorkspaceAccessPropertiesOutput
- type ModifyWorkspaceCreationPropertiesInput
- type ModifyWorkspaceCreationPropertiesOutput
- type ModifyWorkspacePropertiesInput
- type ModifyWorkspacePropertiesOutput
- type ModifyWorkspaceStateInput
- type ModifyWorkspaceStateOutput
- type Options
- type RebootWorkspacesInput
- type RebootWorkspacesOutput
- type RebuildWorkspacesInput
- type RebuildWorkspacesOutput
- type RegisterWorkspaceDirectoryInput
- type RegisterWorkspaceDirectoryOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolverOptions
- type RestoreWorkspaceInput
- type RestoreWorkspaceOutput
- type RevokeIpRulesInput
- type RevokeIpRulesOutput
- type StartWorkspacesInput
- type StartWorkspacesOutput
- type StopWorkspacesInput
- type StopWorkspacesOutput
- type TerminateWorkspacesInput
- type TerminateWorkspacesOutput
- type UpdateRulesOfIpGroupInput
- type UpdateRulesOfIpGroupOutput
- type UpdateWorkspaceImagePermissionInput
- type UpdateWorkspaceImagePermissionOutput
Constants ¶
const ServiceAPIVersion = "2015-04-08"
const ServiceID = "WorkSpaces"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type AssociateIpGroupsInput ¶
type AssociateIpGroupsInput struct { // The identifier of the directory. // // This member is required. DirectoryId *string // The identifiers of one or more IP access control groups. // // This member is required. GroupIds []*string }
type AssociateIpGroupsOutput ¶
type AssociateIpGroupsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AuthorizeIpRulesInput ¶
type AuthorizeIpRulesInput struct { // The identifier of the group. // // This member is required. GroupId *string // The rules to add to the group. // // This member is required. UserRules []*types.IpRuleItem }
type AuthorizeIpRulesOutput ¶
type AuthorizeIpRulesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon WorkSpaces.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateIpGroups ¶
func (c *Client) AssociateIpGroups(ctx context.Context, params *AssociateIpGroupsInput, optFns ...func(*Options)) (*AssociateIpGroupsOutput, error)
Associates the specified IP access control group with the specified directory.
func (*Client) AuthorizeIpRules ¶
func (c *Client) AuthorizeIpRules(ctx context.Context, params *AuthorizeIpRulesInput, optFns ...func(*Options)) (*AuthorizeIpRulesOutput, error)
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.
func (*Client) CopyWorkspaceImage ¶
func (c *Client) CopyWorkspaceImage(ctx context.Context, params *CopyWorkspaceImageInput, optFns ...func(*Options)) (*CopyWorkspaceImageOutput, error)
Copies the specified image from the specified Region to the current Region.
func (*Client) CreateIpGroup ¶
func (c *Client) CreateIpGroup(ctx context.Context, params *CreateIpGroupInput, optFns ...func(*Options)) (*CreateIpGroupOutput, error)
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.
func (*Client) CreateTags ¶
func (c *Client) CreateTags(ctx context.Context, params *CreateTagsInput, optFns ...func(*Options)) (*CreateTagsOutput, error)
Creates the specified tags for the specified WorkSpaces resource.
func (*Client) CreateWorkspaces ¶
func (c *Client) CreateWorkspaces(ctx context.Context, params *CreateWorkspacesInput, optFns ...func(*Options)) (*CreateWorkspacesOutput, error)
Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created.
func (*Client) DeleteIpGroup ¶
func (c *Client) DeleteIpGroup(ctx context.Context, params *DeleteIpGroupInput, optFns ...func(*Options)) (*DeleteIpGroupOutput, error)
Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory.
func (*Client) DeleteTags ¶
func (c *Client) DeleteTags(ctx context.Context, params *DeleteTagsInput, optFns ...func(*Options)) (*DeleteTagsOutput, error)
Deletes the specified tags from the specified WorkSpaces resource.
func (*Client) DeleteWorkspaceImage ¶
func (c *Client) DeleteWorkspaceImage(ctx context.Context, params *DeleteWorkspaceImageInput, optFns ...func(*Options)) (*DeleteWorkspaceImageOutput, error)
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.
func (*Client) DeregisterWorkspaceDirectory ¶
func (c *Client) DeregisterWorkspaceDirectory(ctx context.Context, params *DeregisterWorkspaceDirectoryInput, optFns ...func(*Options)) (*DeregisterWorkspaceDirectoryOutput, error)
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.
func (*Client) DescribeAccount ¶
func (c *Client) DescribeAccount(ctx context.Context, params *DescribeAccountInput, optFns ...func(*Options)) (*DescribeAccountOutput, error)
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
func (*Client) DescribeAccountModifications ¶
func (c *Client) DescribeAccountModifications(ctx context.Context, params *DescribeAccountModificationsInput, optFns ...func(*Options)) (*DescribeAccountModificationsOutput, error)
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
func (*Client) DescribeClientProperties ¶
func (c *Client) DescribeClientProperties(ctx context.Context, params *DescribeClientPropertiesInput, optFns ...func(*Options)) (*DescribeClientPropertiesOutput, error)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
func (*Client) DescribeIpGroups ¶
func (c *Client) DescribeIpGroups(ctx context.Context, params *DescribeIpGroupsInput, optFns ...func(*Options)) (*DescribeIpGroupsOutput, error)
Describes one or more of your IP access control groups.
func (*Client) DescribeTags ¶
func (c *Client) DescribeTags(ctx context.Context, params *DescribeTagsInput, optFns ...func(*Options)) (*DescribeTagsOutput, error)
Describes the specified tags for the specified WorkSpaces resource.
func (*Client) DescribeWorkspaceBundles ¶
func (c *Client) DescribeWorkspaceBundles(ctx context.Context, params *DescribeWorkspaceBundlesInput, optFns ...func(*Options)) (*DescribeWorkspaceBundlesOutput, error)
Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both.
func (*Client) DescribeWorkspaceDirectories ¶
func (c *Client) DescribeWorkspaceDirectories(ctx context.Context, params *DescribeWorkspaceDirectoriesInput, optFns ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error)
Describes the available directories that are registered with Amazon WorkSpaces.
func (*Client) DescribeWorkspaceImagePermissions ¶
func (c *Client) DescribeWorkspaceImagePermissions(ctx context.Context, params *DescribeWorkspaceImagePermissionsInput, optFns ...func(*Options)) (*DescribeWorkspaceImagePermissionsOutput, error)
Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
func (*Client) DescribeWorkspaceImages ¶
func (c *Client) DescribeWorkspaceImages(ctx context.Context, params *DescribeWorkspaceImagesInput, optFns ...func(*Options)) (*DescribeWorkspaceImagesOutput, error)
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
func (*Client) DescribeWorkspaceSnapshots ¶
func (c *Client) DescribeWorkspaceSnapshots(ctx context.Context, params *DescribeWorkspaceSnapshotsInput, optFns ...func(*Options)) (*DescribeWorkspaceSnapshotsOutput, error)
Describes the snapshots for the specified WorkSpace.
func (*Client) DescribeWorkspaces ¶
func (c *Client) DescribeWorkspaces(ctx context.Context, params *DescribeWorkspacesInput, optFns ...func(*Options)) (*DescribeWorkspacesOutput, error)
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.
func (*Client) DescribeWorkspacesConnectionStatus ¶
func (c *Client) DescribeWorkspacesConnectionStatus(ctx context.Context, params *DescribeWorkspacesConnectionStatusInput, optFns ...func(*Options)) (*DescribeWorkspacesConnectionStatusOutput, error)
Describes the connection status of the specified WorkSpaces.
func (*Client) DisassociateIpGroups ¶
func (c *Client) DisassociateIpGroups(ctx context.Context, params *DisassociateIpGroupsInput, optFns ...func(*Options)) (*DisassociateIpGroupsOutput, error)
Disassociates the specified IP access control group from the specified directory.
func (*Client) ImportWorkspaceImage ¶
func (c *Client) ImportWorkspaceImage(ctx context.Context, params *ImportWorkspaceImageInput, optFns ...func(*Options)) (*ImportWorkspaceImageOutput, error)
Imports the specified Windows 7 or Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
func (*Client) ListAvailableManagementCidrRanges ¶
func (c *Client) ListAvailableManagementCidrRanges(ctx context.Context, params *ListAvailableManagementCidrRangesInput, optFns ...func(*Options)) (*ListAvailableManagementCidrRangesOutput, error)
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). 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.
func (*Client) MigrateWorkspace ¶
func (c *Client) MigrateWorkspace(ctx context.Context, params *MigrateWorkspaceInput, optFns ...func(*Options)) (*MigrateWorkspaceOutput, error)
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%</code> 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).
func (*Client) ModifyAccount ¶
func (c *Client) ModifyAccount(ctx context.Context, params *ModifyAccountInput, optFns ...func(*Options)) (*ModifyAccountOutput, error)
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
func (*Client) ModifyClientProperties ¶
func (c *Client) ModifyClientProperties(ctx context.Context, params *ModifyClientPropertiesInput, optFns ...func(*Options)) (*ModifyClientPropertiesOutput, error)
Modifies the properties of the specified Amazon WorkSpaces clients.
func (*Client) ModifySelfservicePermissions ¶
func (c *Client) ModifySelfservicePermissions(ctx context.Context, params *ModifySelfservicePermissionsInput, optFns ...func(*Options)) (*ModifySelfservicePermissionsOutput, error)
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).
func (*Client) ModifyWorkspaceAccessProperties ¶
func (c *Client) ModifyWorkspaceAccessProperties(ctx context.Context, params *ModifyWorkspaceAccessPropertiesInput, optFns ...func(*Options)) (*ModifyWorkspaceAccessPropertiesOutput, error)
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).
func (*Client) ModifyWorkspaceCreationProperties ¶
func (c *Client) ModifyWorkspaceCreationProperties(ctx context.Context, params *ModifyWorkspaceCreationPropertiesInput, optFns ...func(*Options)) (*ModifyWorkspaceCreationPropertiesOutput, error)
Modify the default properties used to create WorkSpaces.
func (*Client) ModifyWorkspaceProperties ¶
func (c *Client) ModifyWorkspaceProperties(ctx context.Context, params *ModifyWorkspacePropertiesInput, optFns ...func(*Options)) (*ModifyWorkspacePropertiesOutput, error)
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).
func (*Client) ModifyWorkspaceState ¶
func (c *Client) ModifyWorkspaceState(ctx context.Context, params *ModifyWorkspaceStateInput, optFns ...func(*Options)) (*ModifyWorkspaceStateOutput, error)
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.
func (*Client) RebootWorkspaces ¶
func (c *Client) RebootWorkspaces(ctx context.Context, params *RebootWorkspacesInput, optFns ...func(*Options)) (*RebootWorkspacesOutput, error)
Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY. This operation is asynchronous and returns before the WorkSpaces have rebooted.
func (*Client) RebuildWorkspaces ¶
func (c *Client) RebuildWorkspaces(ctx context.Context, params *RebuildWorkspacesInput, optFns ...func(*Options)) (*RebuildWorkspacesOutput, error)
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.
func (*Client) RegisterWorkspaceDirectory ¶
func (c *Client) RegisterWorkspaceDirectory(ctx context.Context, params *RegisterWorkspaceDirectoryInput, optFns ...func(*Options)) (*RegisterWorkspaceDirectoryOutput, error)
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).
func (*Client) RestoreWorkspace ¶
func (c *Client) RestoreWorkspace(ctx context.Context, params *RestoreWorkspaceInput, optFns ...func(*Options)) (*RestoreWorkspaceOutput, error)
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.
func (*Client) RevokeIpRules ¶
func (c *Client) RevokeIpRules(ctx context.Context, params *RevokeIpRulesInput, optFns ...func(*Options)) (*RevokeIpRulesOutput, error)
Removes one or more rules from the specified IP access control group.
func (*Client) StartWorkspaces ¶
func (c *Client) StartWorkspaces(ctx context.Context, params *StartWorkspacesInput, optFns ...func(*Options)) (*StartWorkspacesOutput, error)
Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.
func (*Client) StopWorkspaces ¶
func (c *Client) StopWorkspaces(ctx context.Context, params *StopWorkspacesInput, optFns ...func(*Options)) (*StopWorkspacesOutput, error)
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.
func (*Client) TerminateWorkspaces ¶
func (c *Client) TerminateWorkspaces(ctx context.Context, params *TerminateWorkspacesInput, optFns ...func(*Options)) (*TerminateWorkspacesOutput, error)
Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED. This operation is asynchronous and returns before the WorkSpaces have been completely terminated.
func (*Client) UpdateRulesOfIpGroup ¶
func (c *Client) UpdateRulesOfIpGroup(ctx context.Context, params *UpdateRulesOfIpGroupInput, optFns ...func(*Options)) (*UpdateRulesOfIpGroupOutput, error)
Replaces the current rules of the specified IP access control group with the specified rules.
func (*Client) UpdateWorkspaceImagePermission ¶
func (c *Client) UpdateWorkspaceImagePermission(ctx context.Context, params *UpdateWorkspaceImagePermissionInput, optFns ...func(*Options)) (*UpdateWorkspaceImagePermissionOutput, error)
Shares or unshares an image with one account 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.
- 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 AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
type CopyWorkspaceImageInput ¶
type CopyWorkspaceImageInput struct { // The name of the image. // // This member is required. Name *string // The identifier of the source image. // // This member is required. SourceImageId *string // The identifier of the source Region. // // This member is required. SourceRegion *string // A description of the image. Description *string // The tags for the image. Tags []*types.Tag }
type CopyWorkspaceImageOutput ¶
type CopyWorkspaceImageOutput struct { // The identifier of the image. ImageId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateIpGroupInput ¶
type CreateIpGroupInput struct { // The name of the group. // // This member is required. GroupName *string // The description of the group. GroupDesc *string // The tags. Each WorkSpaces resource can have a maximum of 50 tags. Tags []*types.Tag // The rules to add to the group. UserRules []*types.IpRuleItem }
type CreateIpGroupOutput ¶
type CreateIpGroupOutput struct { // The identifier of the group. GroupId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateTagsInput ¶
type CreateTagsInput struct { // The identifier of the WorkSpaces resource. The supported resource types are // WorkSpaces, registered directories, images, custom bundles, and IP access // control groups. // // This member is required. ResourceId *string // The tags. Each WorkSpaces resource can have a maximum of 50 tags. If you want to // add new tags to a set of existing tags, you must submit all of the existing tags // along with the new ones. // // This member is required. Tags []*types.Tag }
type CreateTagsOutput ¶
type CreateTagsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateWorkspacesInput ¶
type CreateWorkspacesInput struct { // The WorkSpaces to create. You can specify up to 25 WorkSpaces. // // This member is required. Workspaces []*types.WorkspaceRequest }
type CreateWorkspacesOutput ¶
type CreateWorkspacesOutput struct { // Information about the WorkSpaces that could not be created. FailedRequests []*types.FailedCreateWorkspaceRequest // 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 []*types.Workspace // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteIpGroupInput ¶
type DeleteIpGroupInput struct { // The identifier of the IP access control group. // // This member is required. GroupId *string }
type DeleteIpGroupOutput ¶
type DeleteIpGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteTagsInput ¶
type DeleteTagsInput struct { // The identifier of the WorkSpaces resource. The supported resource types are // WorkSpaces, registered directories, images, custom bundles, and IP access // control groups. // // This member is required. ResourceId *string // The tag keys. // // This member is required. TagKeys []*string }
type DeleteTagsOutput ¶
type DeleteTagsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteWorkspaceImageInput ¶
type DeleteWorkspaceImageInput struct { // The identifier of the image. // // This member is required. ImageId *string }
type DeleteWorkspaceImageOutput ¶
type DeleteWorkspaceImageOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeregisterWorkspaceDirectoryInput ¶
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. // // This member is required. DirectoryId *string }
type DeregisterWorkspaceDirectoryOutput ¶
type DeregisterWorkspaceDirectoryOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAccountInput ¶
type DescribeAccountInput struct { }
type DescribeAccountModificationsInput ¶
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 }
type DescribeAccountModificationsOutput ¶
type DescribeAccountModificationsOutput struct { // The list of modifications to the configuration of BYOL. AccountModifications []*types.AccountModification // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAccountOutput ¶
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 // The status of BYOL (whether BYOL is enabled or disabled). DedicatedTenancySupport types.DedicatedTenancySupportResultEnum // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeClientPropertiesInput ¶
type DescribeClientPropertiesInput struct { // The resource identifier, in the form of directory IDs. // // This member is required. ResourceIds []*string }
type DescribeClientPropertiesOutput ¶
type DescribeClientPropertiesOutput struct { // Information about the specified Amazon WorkSpaces clients. ClientPropertiesList []*types.ClientPropertiesResult // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeIpGroupsInput ¶
type DescribeIpGroupsInput struct { // The identifiers of one or more IP access control groups. GroupIds []*string // The maximum number of items to return. MaxResults *int32 // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string }
type DescribeIpGroupsOutput ¶
type DescribeIpGroupsOutput struct { // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string // Information about the IP access control groups. Result []*types.WorkspacesIpGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeTagsInput ¶
type DescribeTagsInput struct { // The identifier of the WorkSpaces resource. The supported resource types are // WorkSpaces, registered directories, images, custom bundles, and IP access // control groups. // // This member is required. ResourceId *string }
type DescribeTagsOutput ¶
type DescribeTagsOutput struct { // The tags. TagList []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeWorkspaceBundlesInput ¶
type DescribeWorkspaceBundlesInput struct { // The identifiers of the bundles. You cannot combine this parameter with any other // filter. BundleIds []*string // The token for the next set of results. (You received this token from a previous // call.) NextToken *string // The owner of the bundles. You cannot combine this parameter with any other // filter. Specify AMAZON to describe the bundles provided by AWS or null to // describe the bundles that belong to your account. Owner *string }
type DescribeWorkspaceBundlesOutput ¶
type DescribeWorkspaceBundlesOutput struct { // Information about the bundles. Bundles []*types.WorkspaceBundle // The token to use to retrieve the next set of results, or null if there are no // more results available. This token is valid for one day and must be used within // that time frame. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeWorkspaceDirectoriesInput ¶
type DescribeWorkspaceDirectoriesInput struct { // The identifiers of the directories. If the value is null, all directories are // retrieved. DirectoryIds []*string // The maximum number of directories to return. Limit *int32 // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string }
type DescribeWorkspaceDirectoriesOutput ¶
type DescribeWorkspaceDirectoriesOutput struct { // Information about the directories. Directories []*types.WorkspaceDirectory // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeWorkspaceImagePermissionsInput ¶
type DescribeWorkspaceImagePermissionsInput struct { // The identifier of the image. // // This member is required. ImageId *string // The maximum number of items to return. MaxResults *int32 // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string }
type DescribeWorkspaceImagePermissionsOutput ¶
type DescribeWorkspaceImagePermissionsOutput struct { // The identifier of the image. ImageId *string // The identifiers of the AWS accounts that the image has been shared with. ImagePermissions []*types.ImagePermission // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeWorkspaceImagesInput ¶
type DescribeWorkspaceImagesInput struct { // The identifier of the image. ImageIds []*string // The type (owned or shared) of the image. ImageType types.ImageType // The maximum number of items to return. MaxResults *int32 // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string }
type DescribeWorkspaceImagesOutput ¶
type DescribeWorkspaceImagesOutput struct { // Information about the images. Images []*types.WorkspaceImage // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeWorkspaceSnapshotsInput ¶
type DescribeWorkspaceSnapshotsInput struct { // The identifier of the WorkSpace. // // This member is required. WorkspaceId *string }
type DescribeWorkspaceSnapshotsOutput ¶
type DescribeWorkspaceSnapshotsOutput struct { // Information about the snapshots that can be used to rebuild a WorkSpace. These // snapshots include the user volume. RebuildSnapshots []*types.Snapshot // Information about the snapshots that can be used to restore a WorkSpace. These // snapshots include both the root volume and the user volume. RestoreSnapshots []*types.Snapshot // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeWorkspacesConnectionStatusInput ¶
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 // The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces. WorkspaceIds []*string }
type DescribeWorkspacesConnectionStatusOutput ¶
type DescribeWorkspacesConnectionStatusOutput struct { // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string // Information about the connection status of the WorkSpace. WorkspacesConnectionStatus []*types.WorkspaceConnectionStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 // 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 // The maximum number of items to return. Limit *int32 // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string // The name of the directory user. You must specify this parameter with // DirectoryId. UserName *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 }
type DescribeWorkspacesOutput ¶
type DescribeWorkspacesOutput struct { // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string // Information about the WorkSpaces. Because CreateWorkspaces is an asynchronous // operation, some of the returned information could be incomplete. Workspaces []*types.Workspace // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisassociateIpGroupsInput ¶
type DisassociateIpGroupsInput struct { // The identifier of the directory. // // This member is required. DirectoryId *string // The identifiers of one or more IP access control groups. // // This member is required. GroupIds []*string }
type DisassociateIpGroupsOutput ¶
type DisassociateIpGroupsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ImportWorkspaceImageInput ¶
type ImportWorkspaceImageInput struct { // The identifier of the EC2 image. // // This member is required. Ec2ImageId *string // The description of the WorkSpace image. // // This member is required. ImageDescription *string // The name of the WorkSpace image. // // This member is required. ImageName *string // The ingestion process to be used when importing the image. // // This member is required. IngestionProcess types.WorkspaceImageIngestionProcess // The tags. Each WorkSpaces resource can have a maximum of 50 tags. Tags []*types.Tag }
type ImportWorkspaceImageOutput ¶
type ImportWorkspaceImageOutput struct { // The identifier of the WorkSpace image. ImageId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListAvailableManagementCidrRangesInput ¶
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). // // This member is required. ManagementCidrRangeConstraint *string // The maximum number of items to return. MaxResults *int32 // If you received a NextToken from a previous call that was paginated, provide // this token to receive the next set of results. NextToken *string }
type ListAvailableManagementCidrRangesOutput ¶
type ListAvailableManagementCidrRangesOutput struct { // The list of available IP address ranges, specified as IPv4 CIDR blocks. ManagementCidrRanges []*string // The token to use to retrieve the next set of results, or null if no more results // are available. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type MigrateWorkspaceInput ¶
type MigrateWorkspaceInput struct { // The identifier of the target bundle type to migrate the WorkSpace to. // // This member is required. BundleId *string // The identifier of the WorkSpace to migrate from. // // This member is required. SourceWorkspaceId *string }
type MigrateWorkspaceOutput ¶
type MigrateWorkspaceOutput struct { // The original identifier of the WorkSpace that is being migrated. SourceWorkspaceId *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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ModifyAccountInput ¶
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 // The status of BYOL. DedicatedTenancySupport types.DedicatedTenancySupportEnum }
type ModifyAccountOutput ¶
type ModifyAccountOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ModifyClientPropertiesInput ¶
type ModifyClientPropertiesInput struct { // Information about the Amazon WorkSpaces client. // // This member is required. ClientProperties *types.ClientProperties // The resource identifiers, in the form of directory IDs. // // This member is required. ResourceId *string }
type ModifyClientPropertiesOutput ¶
type ModifyClientPropertiesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ModifySelfservicePermissionsInput ¶
type ModifySelfservicePermissionsInput struct { // The identifier of the directory. // // This member is required. ResourceId *string // The permissions to enable or disable self-service capabilities. // // This member is required. SelfservicePermissions *types.SelfservicePermissions }
type ModifySelfservicePermissionsOutput ¶
type ModifySelfservicePermissionsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ModifyWorkspaceAccessPropertiesInput ¶
type ModifyWorkspaceAccessPropertiesInput struct { // The identifier of the directory. // // This member is required. ResourceId *string // The device types and operating systems to enable or disable for access. // // This member is required. WorkspaceAccessProperties *types.WorkspaceAccessProperties }
type ModifyWorkspaceAccessPropertiesOutput ¶
type ModifyWorkspaceAccessPropertiesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ModifyWorkspaceCreationPropertiesInput ¶
type ModifyWorkspaceCreationPropertiesInput struct { // The identifier of the directory. // // This member is required. ResourceId *string // The default properties for creating WorkSpaces. // // This member is required. WorkspaceCreationProperties *types.WorkspaceCreationProperties }
type ModifyWorkspaceCreationPropertiesOutput ¶
type ModifyWorkspaceCreationPropertiesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ModifyWorkspacePropertiesInput ¶
type ModifyWorkspacePropertiesInput struct { // The identifier of the WorkSpace. // // This member is required. WorkspaceId *string // The properties of the WorkSpace. // // This member is required. WorkspaceProperties *types.WorkspaceProperties }
type ModifyWorkspacePropertiesOutput ¶
type ModifyWorkspacePropertiesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ModifyWorkspaceStateInput ¶
type ModifyWorkspaceStateInput struct { // The identifier of the WorkSpace. // // This member is required. WorkspaceId *string // The WorkSpace state. // // This member is required. WorkspaceState types.TargetWorkspaceState }
type ModifyWorkspaceStateOutput ¶
type ModifyWorkspaceStateOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type RebootWorkspacesInput ¶
type RebootWorkspacesInput struct { // The WorkSpaces to reboot. You can specify up to 25 WorkSpaces. // // This member is required. RebootWorkspaceRequests []*types.RebootRequest }
type RebootWorkspacesOutput ¶
type RebootWorkspacesOutput struct { // Information about the WorkSpaces that could not be rebooted. FailedRequests []*types.FailedWorkspaceChangeRequest // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type RebuildWorkspacesInput ¶
type RebuildWorkspacesInput struct { // The WorkSpace to rebuild. You can specify a single WorkSpace. // // This member is required. RebuildWorkspaceRequests []*types.RebuildRequest }
type RebuildWorkspacesOutput ¶
type RebuildWorkspacesOutput struct { // Information about the WorkSpace that could not be rebuilt. FailedRequests []*types.FailedWorkspaceChangeRequest // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type RegisterWorkspaceDirectoryInput ¶
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. // // This member is required. DirectoryId *string // 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. // // This member is required. EnableWorkDocs *bool // Indicates whether self-service capabilities are enabled or disabled. EnableSelfService *bool // 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 // The tags associated with the directory. Tags []*types.Tag // 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 AWS // 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 types.Tenancy }
type RegisterWorkspaceDirectoryOutput ¶
type RegisterWorkspaceDirectoryOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type RestoreWorkspaceInput ¶
type RestoreWorkspaceInput struct { // The identifier of the WorkSpace. // // This member is required. WorkspaceId *string }
type RestoreWorkspaceOutput ¶
type RestoreWorkspaceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type RevokeIpRulesInput ¶
type RevokeIpRulesInput struct { // The identifier of the group. // // This member is required. GroupId *string // The rules to remove from the group. // // This member is required. UserRules []*string }
type RevokeIpRulesOutput ¶
type RevokeIpRulesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StartWorkspacesInput ¶
type StartWorkspacesInput struct { // The WorkSpaces to start. You can specify up to 25 WorkSpaces. // // This member is required. StartWorkspaceRequests []*types.StartRequest }
type StartWorkspacesOutput ¶
type StartWorkspacesOutput struct { // Information about the WorkSpaces that could not be started. FailedRequests []*types.FailedWorkspaceChangeRequest // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type StopWorkspacesInput ¶
type StopWorkspacesInput struct { // The WorkSpaces to stop. You can specify up to 25 WorkSpaces. // // This member is required. StopWorkspaceRequests []*types.StopRequest }
type StopWorkspacesOutput ¶
type StopWorkspacesOutput struct { // Information about the WorkSpaces that could not be stopped. FailedRequests []*types.FailedWorkspaceChangeRequest // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TerminateWorkspacesInput ¶
type TerminateWorkspacesInput struct { // The WorkSpaces to terminate. You can specify up to 25 WorkSpaces. // // This member is required. TerminateWorkspaceRequests []*types.TerminateRequest }
type TerminateWorkspacesOutput ¶
type TerminateWorkspacesOutput struct { // Information about the WorkSpaces that could not be terminated. FailedRequests []*types.FailedWorkspaceChangeRequest // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateRulesOfIpGroupInput ¶
type UpdateRulesOfIpGroupInput struct { // The identifier of the group. // // This member is required. GroupId *string // One or more rules. // // This member is required. UserRules []*types.IpRuleItem }
type UpdateRulesOfIpGroupOutput ¶
type UpdateRulesOfIpGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateWorkspaceImagePermissionInput ¶
type UpdateWorkspaceImagePermissionInput struct { // The permission to copy the image. This permission can be revoked only after an // image has been shared. // // This member is required. AllowCopyImage *bool // The identifier of the image. // // This member is required. ImageId *string // The identifier of the AWS account to share or unshare the image with. // // This member is required. *string }
type UpdateWorkspaceImagePermissionOutput ¶
type UpdateWorkspaceImagePermissionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_AssociateIpGroups.go api_op_AuthorizeIpRules.go api_op_CopyWorkspaceImage.go api_op_CreateIpGroup.go api_op_CreateTags.go api_op_CreateWorkspaces.go api_op_DeleteIpGroup.go api_op_DeleteTags.go api_op_DeleteWorkspaceImage.go api_op_DeregisterWorkspaceDirectory.go api_op_DescribeAccount.go api_op_DescribeAccountModifications.go api_op_DescribeClientProperties.go api_op_DescribeIpGroups.go api_op_DescribeTags.go api_op_DescribeWorkspaceBundles.go api_op_DescribeWorkspaceDirectories.go api_op_DescribeWorkspaceImagePermissions.go api_op_DescribeWorkspaceImages.go api_op_DescribeWorkspaceSnapshots.go api_op_DescribeWorkspaces.go api_op_DescribeWorkspacesConnectionStatus.go api_op_DisassociateIpGroups.go api_op_ImportWorkspaceImage.go api_op_ListAvailableManagementCidrRanges.go api_op_MigrateWorkspace.go api_op_ModifyAccount.go api_op_ModifyClientProperties.go api_op_ModifySelfservicePermissions.go api_op_ModifyWorkspaceAccessProperties.go api_op_ModifyWorkspaceCreationProperties.go api_op_ModifyWorkspaceProperties.go api_op_ModifyWorkspaceState.go api_op_RebootWorkspaces.go api_op_RebuildWorkspaces.go api_op_RegisterWorkspaceDirectory.go api_op_RestoreWorkspace.go api_op_RevokeIpRules.go api_op_StartWorkspaces.go api_op_StopWorkspaces.go api_op_TerminateWorkspaces.go api_op_UpdateRulesOfIpGroup.go api_op_UpdateWorkspaceImagePermission.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.27.0
- Published
- Oct 17, 2020
- Platform
- windows/amd64
- Imports
- 26 packages
- Last checked
- now –
Tools for package owners.