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
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type AssociateConnectionAliasInput
- type AssociateConnectionAliasOutput
- 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) AssociateConnectionAlias(ctx context.Context, params *AssociateConnectionAliasInput, optFns ...func(*Options)) (*AssociateConnectionAliasOutput, error)
- 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) CreateConnectionAlias(ctx context.Context, params *CreateConnectionAliasInput, optFns ...func(*Options)) (*CreateConnectionAliasOutput, 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) CreateWorkspaceBundle(ctx context.Context, params *CreateWorkspaceBundleInput, optFns ...func(*Options)) (*CreateWorkspaceBundleOutput, error)
- func (c *Client) CreateWorkspaces(ctx context.Context, params *CreateWorkspacesInput, optFns ...func(*Options)) (*CreateWorkspacesOutput, error)
- func (c *Client) DeleteConnectionAlias(ctx context.Context, params *DeleteConnectionAliasInput, optFns ...func(*Options)) (*DeleteConnectionAliasOutput, 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) DeleteWorkspaceBundle(ctx context.Context, params *DeleteWorkspaceBundleInput, optFns ...func(*Options)) (*DeleteWorkspaceBundleOutput, 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) DescribeConnectionAliasPermissions(ctx context.Context, params *DescribeConnectionAliasPermissionsInput, optFns ...func(*Options)) (*DescribeConnectionAliasPermissionsOutput, error)
- func (c *Client) DescribeConnectionAliases(ctx context.Context, params *DescribeConnectionAliasesInput, optFns ...func(*Options)) (*DescribeConnectionAliasesOutput, 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) DisassociateConnectionAlias(ctx context.Context, params *DisassociateConnectionAliasInput, optFns ...func(*Options)) (*DisassociateConnectionAliasOutput, 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) UpdateConnectionAliasPermission(ctx context.Context, params *UpdateConnectionAliasPermissionInput, optFns ...func(*Options)) (*UpdateConnectionAliasPermissionOutput, error)
- func (c *Client) UpdateRulesOfIpGroup(ctx context.Context, params *UpdateRulesOfIpGroupInput, optFns ...func(*Options)) (*UpdateRulesOfIpGroupOutput, error)
- func (c *Client) UpdateWorkspaceBundle(ctx context.Context, params *UpdateWorkspaceBundleInput, optFns ...func(*Options)) (*UpdateWorkspaceBundleOutput, error)
- func (c *Client) UpdateWorkspaceImagePermission(ctx context.Context, params *UpdateWorkspaceImagePermissionInput, optFns ...func(*Options)) (*UpdateWorkspaceImagePermissionOutput, error)
- type CopyWorkspaceImageInput
- type CopyWorkspaceImageOutput
- type CreateConnectionAliasInput
- type CreateConnectionAliasOutput
- type CreateIpGroupInput
- type CreateIpGroupOutput
- type CreateTagsInput
- type CreateTagsOutput
- type CreateWorkspaceBundleInput
- type CreateWorkspaceBundleOutput
- type CreateWorkspacesInput
- type CreateWorkspacesOutput
- type DeleteConnectionAliasInput
- type DeleteConnectionAliasOutput
- type DeleteIpGroupInput
- type DeleteIpGroupOutput
- type DeleteTagsInput
- type DeleteTagsOutput
- type DeleteWorkspaceBundleInput
- type DeleteWorkspaceBundleOutput
- type DeleteWorkspaceImageInput
- type DeleteWorkspaceImageOutput
- type DeregisterWorkspaceDirectoryInput
- type DeregisterWorkspaceDirectoryOutput
- type DescribeAccountInput
- type DescribeAccountModificationsInput
- type DescribeAccountModificationsOutput
- type DescribeAccountOutput
- type DescribeClientPropertiesInput
- type DescribeClientPropertiesOutput
- type DescribeConnectionAliasPermissionsInput
- type DescribeConnectionAliasPermissionsOutput
- type DescribeConnectionAliasesInput
- type DescribeConnectionAliasesOutput
- type DescribeIpGroupsInput
- type DescribeIpGroupsOutput
- type DescribeTagsInput
- type DescribeTagsOutput
- type DescribeWorkspaceBundlesAPIClient
- type DescribeWorkspaceBundlesInput
- type DescribeWorkspaceBundlesOutput
- type DescribeWorkspaceBundlesPaginator
- func NewDescribeWorkspaceBundlesPaginator(client DescribeWorkspaceBundlesAPIClient, params *DescribeWorkspaceBundlesInput, optFns ...func(*DescribeWorkspaceBundlesPaginatorOptions)) *DescribeWorkspaceBundlesPaginator
- func (p *DescribeWorkspaceBundlesPaginator) HasMorePages() bool
- func (p *DescribeWorkspaceBundlesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspaceBundlesOutput, error)
- type DescribeWorkspaceBundlesPaginatorOptions
- type DescribeWorkspaceDirectoriesAPIClient
- type DescribeWorkspaceDirectoriesInput
- type DescribeWorkspaceDirectoriesOutput
- type DescribeWorkspaceDirectoriesPaginator
- func NewDescribeWorkspaceDirectoriesPaginator(client DescribeWorkspaceDirectoriesAPIClient, params *DescribeWorkspaceDirectoriesInput, optFns ...func(*DescribeWorkspaceDirectoriesPaginatorOptions)) *DescribeWorkspaceDirectoriesPaginator
- func (p *DescribeWorkspaceDirectoriesPaginator) HasMorePages() bool
- func (p *DescribeWorkspaceDirectoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error)
- type DescribeWorkspaceDirectoriesPaginatorOptions
- type DescribeWorkspaceImagePermissionsInput
- type DescribeWorkspaceImagePermissionsOutput
- type DescribeWorkspaceImagesInput
- type DescribeWorkspaceImagesOutput
- type DescribeWorkspaceSnapshotsInput
- type DescribeWorkspaceSnapshotsOutput
- type DescribeWorkspacesAPIClient
- type DescribeWorkspacesConnectionStatusInput
- type DescribeWorkspacesConnectionStatusOutput
- type DescribeWorkspacesInput
- type DescribeWorkspacesOutput
- type DescribeWorkspacesPaginator
- func NewDescribeWorkspacesPaginator(client DescribeWorkspacesAPIClient, params *DescribeWorkspacesInput, optFns ...func(*DescribeWorkspacesPaginatorOptions)) *DescribeWorkspacesPaginator
- func (p *DescribeWorkspacesPaginator) HasMorePages() bool
- func (p *DescribeWorkspacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspacesOutput, error)
- type DescribeWorkspacesPaginatorOptions
- type DisassociateConnectionAliasInput
- type DisassociateConnectionAliasOutput
- type DisassociateIpGroupsInput
- type DisassociateIpGroupsOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- 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 RestoreWorkspaceInput
- type RestoreWorkspaceOutput
- type RevokeIpRulesInput
- type RevokeIpRulesOutput
- type StartWorkspacesInput
- type StartWorkspacesOutput
- type StopWorkspacesInput
- type StopWorkspacesOutput
- type TerminateWorkspacesInput
- type TerminateWorkspacesOutput
- type UpdateConnectionAliasPermissionInput
- type UpdateConnectionAliasPermissionOutput
- type UpdateRulesOfIpGroupInput
- type UpdateRulesOfIpGroupOutput
- type UpdateWorkspaceBundleInput
- type UpdateWorkspaceBundleOutput
- 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
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type AssociateConnectionAliasInput ¶
type AssociateConnectionAliasInput struct { // The identifier of the connection alias. // // This member is required. AliasId *string // The identifier of the directory to associate the connection alias with. // // This member is required. ResourceId *string }
type AssociateConnectionAliasOutput ¶
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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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) AssociateConnectionAlias ¶
func (c *Client) AssociateConnectionAlias(ctx context.Context, params *AssociateConnectionAliasInput, optFns ...func(*Options)) (*AssociateConnectionAliasOutput, error)
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.
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. 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 the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support. Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the AWS account ID 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.
func (*Client) CreateConnectionAlias ¶
func (c *Client) CreateConnectionAlias(ctx context.Context, params *CreateConnectionAliasInput, optFns ...func(*Options)) (*CreateConnectionAliasOutput, error)
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).
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) CreateWorkspaceBundle ¶
func (c *Client) CreateWorkspaceBundle(ctx context.Context, params *CreateWorkspaceBundleInput, optFns ...func(*Options)) (*CreateWorkspaceBundleOutput, error)
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).
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) DeleteConnectionAlias ¶
func (c *Client) DeleteConnectionAlias(ctx context.Context, params *DeleteConnectionAliasInput, optFns ...func(*Options)) (*DeleteConnectionAliasOutput, error)
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.
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) DeleteWorkspaceBundle ¶
func (c *Client) DeleteWorkspaceBundle(ctx context.Context, params *DeleteWorkspaceBundleInput, optFns ...func(*Options)) (*DeleteWorkspaceBundleOutput, error)
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).
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. 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 AWS Directory Services 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.
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) DescribeConnectionAliasPermissions ¶
func (c *Client) DescribeConnectionAliasPermissions(ctx context.Context, params *DescribeConnectionAliasPermissionsInput, optFns ...func(*Options)) (*DescribeConnectionAliasPermissionsOutput, error)
Describes the permissions that the owner of a connection alias has granted to another AWS 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).
func (*Client) DescribeConnectionAliases ¶
func (c *Client) DescribeConnectionAliases(ctx context.Context, params *DescribeConnectionAliasesInput, optFns ...func(*Options)) (*DescribeConnectionAliasesOutput, error)
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).
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) DisassociateConnectionAlias ¶
func (c *Client) DisassociateConnectionAlias(ctx context.Context, params *DisassociateConnectionAliasInput, optFns ...func(*Options)) (*DisassociateConnectionAliasOutput, error)
Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS 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.
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 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS 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).
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). This operation can be run only by AWS 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.
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 AWS 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 AWS Directory Services 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.
func (*Client) UpdateConnectionAliasPermission ¶
func (c *Client) UpdateConnectionAliasPermission(ctx context.Context, params *UpdateConnectionAliasPermissionInput, optFns ...func(*Options)) (*UpdateConnectionAliasPermissionOutput, error)
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.
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) UpdateWorkspaceBundle ¶
func (c *Client) UpdateWorkspaceBundle(ctx context.Context, params *UpdateWorkspaceBundleInput, optFns ...func(*Options)) (*UpdateWorkspaceBundleOutput, error)
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.
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 in the same AWS 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 AWS Regions as needed. In the China (Ningxia) Region, you can copy images only within the same Region. In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS 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 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 CreateConnectionAliasInput ¶
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 AWS 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. // // This member is required. ConnectionString *string // The tags to associate with the connection alias. Tags []types.Tag }
type CreateConnectionAliasOutput ¶
type CreateConnectionAliasOutput struct { // The identifier of the connection alias. AliasId *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, IP access control // groups, and connection aliases. // // This member is required. ResourceId *string // The tags. Each WorkSpaces resource can have a maximum of 50 tags. // // This member is required. Tags []types.Tag }
type CreateTagsOutput ¶
type CreateTagsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateWorkspaceBundleInput ¶
type CreateWorkspaceBundleInput struct { // The description of the bundle. // // This member is required. BundleDescription *string // The name of the bundle. // // This member is required. BundleName *string // Describes the compute type of the bundle. // // This member is required. ComputeType *types.ComputeType // The identifier of the image that is used to create the bundle. // // This member is required. ImageId *string // Describes the user volume for a WorkSpace bundle. // // This member is required. UserStorage *types.UserStorage // Describes the root volume for a WorkSpace bundle. RootStorage *types.RootStorage // The tags associated with the bundle. To add tags at the same time that you're // creating the bundle, you must create an IAM policy that grants your IAM user // permissions to use workspaces:CreateTags. Tags []types.Tag }
type CreateWorkspaceBundleOutput ¶
type CreateWorkspaceBundleOutput struct { // Describes a WorkSpace bundle. WorkspaceBundle *types.WorkspaceBundle // 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 DeleteConnectionAliasInput ¶
type DeleteConnectionAliasInput struct { // The identifier of the connection alias to delete. // // This member is required. AliasId *string }
type DeleteConnectionAliasOutput ¶
type DeleteConnectionAliasOutput struct { // 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, IP access control // groups, and connection aliases. // // 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 DeleteWorkspaceBundleInput ¶
type DeleteWorkspaceBundleInput struct { // The identifier of the bundle. BundleId *string }
type DeleteWorkspaceBundleOutput ¶
type DeleteWorkspaceBundleOutput 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 page of results. This value is null when // there are no more results to return. 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 DescribeConnectionAliasPermissionsInput ¶
type DescribeConnectionAliasPermissionsInput struct { // The identifier of the connection alias. // // This member is required. AliasId *string // The maximum number of results 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 DescribeConnectionAliasPermissionsOutput ¶
type DescribeConnectionAliasPermissionsOutput struct { // The identifier of the connection alias. AliasId *string // The permissions associated with a connection alias. ConnectionAliasPermissions []types.ConnectionAliasPermission // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeConnectionAliasesInput ¶
type DescribeConnectionAliasesInput struct { // The identifiers of the connection aliases to describe. AliasIds []string // The maximum number of connection aliases 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 identifier of the directory associated with the connection alias. ResourceId *string }
type DescribeConnectionAliasesOutput ¶
type DescribeConnectionAliasesOutput struct { // Information about the specified connection aliases. ConnectionAliases []types.ConnectionAlias // 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 // 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 page of results. This value is null when // there are no more results to return. 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, IP access control // groups, and connection aliases. // // 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 DescribeWorkspaceBundlesAPIClient ¶
type DescribeWorkspaceBundlesAPIClient interface { DescribeWorkspaceBundles(context.Context, *DescribeWorkspaceBundlesInput, ...func(*Options)) (*DescribeWorkspaceBundlesOutput, error) }
DescribeWorkspaceBundlesAPIClient is a client that implements the DescribeWorkspaceBundles operation.
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. To describe the bundles provided by AWS, specify AMAZON. To describe the // bundles that belong to your account, don't specify a value. Owner *string }
type DescribeWorkspaceBundlesOutput ¶
type DescribeWorkspaceBundlesOutput struct { // Information about the bundles. Bundles []types.WorkspaceBundle // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeWorkspaceBundlesPaginator ¶
type DescribeWorkspaceBundlesPaginator struct {
// contains filtered or unexported fields
}
DescribeWorkspaceBundlesPaginator is a paginator for DescribeWorkspaceBundles
func NewDescribeWorkspaceBundlesPaginator ¶
func NewDescribeWorkspaceBundlesPaginator(client DescribeWorkspaceBundlesAPIClient, params *DescribeWorkspaceBundlesInput, optFns ...func(*DescribeWorkspaceBundlesPaginatorOptions)) *DescribeWorkspaceBundlesPaginator
NewDescribeWorkspaceBundlesPaginator returns a new DescribeWorkspaceBundlesPaginator
func (*DescribeWorkspaceBundlesPaginator) HasMorePages ¶
func (p *DescribeWorkspaceBundlesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeWorkspaceBundlesPaginator) NextPage ¶
func (p *DescribeWorkspaceBundlesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspaceBundlesOutput, error)
NextPage retrieves the next DescribeWorkspaceBundles page.
type DescribeWorkspaceBundlesPaginatorOptions ¶
type DescribeWorkspaceBundlesPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeWorkspaceBundlesPaginatorOptions is the paginator options for DescribeWorkspaceBundles
type DescribeWorkspaceDirectoriesAPIClient ¶
type DescribeWorkspaceDirectoriesAPIClient interface { DescribeWorkspaceDirectories(context.Context, *DescribeWorkspaceDirectoriesInput, ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error) }
DescribeWorkspaceDirectoriesAPIClient is a client that implements the DescribeWorkspaceDirectories operation.
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 page of results. This value is null when // there are no more results to return. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeWorkspaceDirectoriesPaginator ¶
type DescribeWorkspaceDirectoriesPaginator struct {
// contains filtered or unexported fields
}
DescribeWorkspaceDirectoriesPaginator is a paginator for DescribeWorkspaceDirectories
func NewDescribeWorkspaceDirectoriesPaginator ¶
func NewDescribeWorkspaceDirectoriesPaginator(client DescribeWorkspaceDirectoriesAPIClient, params *DescribeWorkspaceDirectoriesInput, optFns ...func(*DescribeWorkspaceDirectoriesPaginatorOptions)) *DescribeWorkspaceDirectoriesPaginator
NewDescribeWorkspaceDirectoriesPaginator returns a new DescribeWorkspaceDirectoriesPaginator
func (*DescribeWorkspaceDirectoriesPaginator) HasMorePages ¶
func (p *DescribeWorkspaceDirectoriesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeWorkspaceDirectoriesPaginator) NextPage ¶
func (p *DescribeWorkspaceDirectoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error)
NextPage retrieves the next DescribeWorkspaceDirectories page.
type DescribeWorkspaceDirectoriesPaginatorOptions ¶
type DescribeWorkspaceDirectoriesPaginatorOptions struct { // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeWorkspaceDirectoriesPaginatorOptions is the paginator options for DescribeWorkspaceDirectories
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 page of results. This value is null when // there are no more results to return. 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 page of results. This value is null when // there are no more results to return. 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 DescribeWorkspacesAPIClient ¶
type DescribeWorkspacesAPIClient interface { DescribeWorkspaces(context.Context, *DescribeWorkspacesInput, ...func(*Options)) (*DescribeWorkspacesOutput, error) }
DescribeWorkspacesAPIClient is a client that implements the DescribeWorkspaces operation.
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 page of results. This value is null when // there are no more results to return. 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 page of results. This value is null when // there are no more results to return. 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 DescribeWorkspacesPaginator ¶
type DescribeWorkspacesPaginator struct {
// contains filtered or unexported fields
}
DescribeWorkspacesPaginator is a paginator for DescribeWorkspaces
func NewDescribeWorkspacesPaginator ¶
func NewDescribeWorkspacesPaginator(client DescribeWorkspacesAPIClient, params *DescribeWorkspacesInput, optFns ...func(*DescribeWorkspacesPaginatorOptions)) *DescribeWorkspacesPaginator
NewDescribeWorkspacesPaginator returns a new DescribeWorkspacesPaginator
func (*DescribeWorkspacesPaginator) HasMorePages ¶
func (p *DescribeWorkspacesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeWorkspacesPaginator) NextPage ¶
func (p *DescribeWorkspacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspacesOutput, error)
NextPage retrieves the next DescribeWorkspaces page.
type DescribeWorkspacesPaginatorOptions ¶
type DescribeWorkspacesPaginatorOptions struct { // The maximum number of items to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeWorkspacesPaginatorOptions is the paginator options for DescribeWorkspaces
type DisassociateConnectionAliasInput ¶
type DisassociateConnectionAliasInput struct { // The identifier of the connection alias to disassociate. // // This member is required. AliasId *string }
type DisassociateConnectionAliasOutput ¶
type DisassociateConnectionAliasOutput struct { // 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 EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
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, optFns ...func(*v4.SignerOptions)) 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, depending on which // protocol you want to use for your BYOL Workspace image, either PCoIP or // WorkSpaces Streaming Protocol (WSP). To use WSP, specify a value that ends in // _WSP. To use PCoIP, specify a value that does not end in _WSP. For // non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify // BYOL_REGULAR or BYOL_REGULAR_WSP, depending on the protocol. // // This member is required. IngestionProcess types.WorkspaceImageIngestionProcess // If specified, the version of Microsoft Office to subscribe to. Valid only for // Windows 10 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. Applications []types.Application // 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 page of results. This value is null when // there are no more results to return. 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 // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // 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 aws.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 EndpointResolverOptions }
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 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 UpdateConnectionAliasPermissionInput ¶
type UpdateConnectionAliasPermissionInput struct { // The identifier of the connection alias that you want to update permissions for. // // This member is required. AliasId *string // Indicates whether to share or unshare the connection alias with the specified // AWS account. // // This member is required. ConnectionAliasPermission *types.ConnectionAliasPermission }
type UpdateConnectionAliasPermissionOutput ¶
type UpdateConnectionAliasPermissionOutput struct { // 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 UpdateWorkspaceBundleInput ¶
type UpdateWorkspaceBundleInput struct { // The identifier of the bundle. BundleId *string // The identifier of the image. ImageId *string }
type UpdateWorkspaceBundleOutput ¶
type UpdateWorkspaceBundleOutput 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. Before // sharing the image, confirm that you are sharing to the correct AWS account ID. // // 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_AssociateConnectionAlias.go api_op_AssociateIpGroups.go api_op_AuthorizeIpRules.go api_op_CopyWorkspaceImage.go api_op_CreateConnectionAlias.go api_op_CreateIpGroup.go api_op_CreateTags.go api_op_CreateWorkspaceBundle.go api_op_CreateWorkspaces.go api_op_DeleteConnectionAlias.go api_op_DeleteIpGroup.go api_op_DeleteTags.go api_op_DeleteWorkspaceBundle.go api_op_DeleteWorkspaceImage.go api_op_DeregisterWorkspaceDirectory.go api_op_DescribeAccount.go api_op_DescribeAccountModifications.go api_op_DescribeClientProperties.go api_op_DescribeConnectionAliasPermissions.go api_op_DescribeConnectionAliases.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_DisassociateConnectionAlias.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_UpdateConnectionAliasPermission.go api_op_UpdateRulesOfIpGroup.go api_op_UpdateWorkspaceBundle.go api_op_UpdateWorkspaceImagePermission.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.2.0
- Published
- Mar 18, 2021
- Platform
- windows/amd64
- Imports
- 27 packages
- Last checked
- now –
Tools for package owners.