workspaces

package module
v1.39.0 Latest Latest
Warning

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

 Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 39 Imported by: 47

Documentation

Overview

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 or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers. This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/wsp.html) in the Amazon Web Services General Reference. You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide (https://docs.aws.amazon.com/workspaces/latest/adminguide/) . For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide (https://docs.aws.amazon.com/workspaces/latest/userguide/) . For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference (https://docs.aws.amazon.com/cli/latest/reference/workspaces/index.html) .

Index

Constants

View Source 
const ServiceAPIVersion = "2015-04-08"
View Source 
const ServiceID = "WorkSpaces"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.29.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.33.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.33.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AcceptAccountLinkInvitationInput added in v1.39.0 

type AcceptAccountLinkInvitationInput struct {

	// The identifier of the account link.
	//
	// This member is required.
	LinkId *string

	// A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent
	// creation.
	ClientToken *string
	// contains filtered or unexported fields
}

type AcceptAccountLinkInvitationOutput added in v1.39.0 

type AcceptAccountLinkInvitationOutput struct {

	// Information about the account link.
	AccountLink *types.AccountLink

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateConnectionAliasInput added in v0.29.0 

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

type AssociateConnectionAliasOutput added in v0.29.0 

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

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

type AssociateIpGroupsOutput 

type AssociateIpGroupsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateWorkspaceApplicationInput added in v1.31.0 

type AssociateWorkspaceApplicationInput struct {

	// The identifier of the application.
	//
	// This member is required.
	ApplicationId *string

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

type AssociateWorkspaceApplicationOutput added in v1.31.0 

type AssociateWorkspaceApplicationOutput struct {

	// Information about the association between the specified WorkSpace and the
	// specified application.
	Association *types.WorkspaceResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.33.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.33.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

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

type AuthorizeIpRulesOutput 

type AuthorizeIpRulesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Client 

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

Client provides the API client to make operations call for Amazon WorkSpaces.

func New 

func New(options Options, optFns ...func(*Options)) *Client

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 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AcceptAccountLinkInvitation added in v1.39.0 

func (c *Client) AcceptAccountLinkInvitation(ctx context.Context, params *AcceptAccountLinkInvitationInput, optFns ...func(*Options)) (*AcceptAccountLinkInvitationOutput, error)

Accepts the account link invitation. There's currently no unlinking capability after you accept the account linking invitation.

func (*Client) AssociateConnectionAlias added in v0.29.0 

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

func (c *Client) AssociateWorkspaceApplication(ctx context.Context, params *AssociateWorkspaceApplicationInput, optFns ...func(*Options)) (*AssociateWorkspaceApplicationOutput, error)

Associates the specified application to the specified WorkSpace.

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 Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support. Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html) and DescribeWorkspaceImagePermissions (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html) API operations.

func (*Client) CreateAccountLinkInvitation added in v1.39.0 

func (c *Client) CreateAccountLinkInvitation(ctx context.Context, params *CreateAccountLinkInvitationInput, optFns ...func(*Options)) (*CreateAccountLinkInvitationOutput, error)

Creates the account link invitation.

func (*Client) CreateConnectClientAddIn added in v1.14.0 

func (c *Client) CreateConnectClientAddIn(ctx context.Context, params *CreateConnectClientAddInInput, optFns ...func(*Options)) (*CreateConnectClientAddInOutput, error)

Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory. This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

func (*Client) CreateConnectionAlias added in v0.29.0 

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

func (c *Client) CreateStandbyWorkspaces(ctx context.Context, params *CreateStandbyWorkspacesInput, optFns ...func(*Options)) (*CreateStandbyWorkspacesOutput, error)

Creates a standby WorkSpace in a secondary Region.

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

func (c *Client) CreateUpdatedWorkspaceImage(ctx context.Context, params *CreateUpdatedWorkspaceImageInput, optFns ...func(*Options)) (*CreateUpdatedWorkspaceImageOutput, error)

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components. To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html) .

  • Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
  • Microsoft Windows updates and other application updates are not included in the update process.
  • The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.

func (*Client) CreateWorkspaceBundle added in v1.2.0 

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) CreateWorkspaceImage added in v1.21.0 

func (c *Client) CreateWorkspaceImage(ctx context.Context, params *CreateWorkspaceImageInput, optFns ...func(*Options)) (*CreateWorkspaceImageOutput, error)

Creates a new WorkSpace image from an existing WorkSpace.

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.

  • The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/) .
  • You don't need to specify the PCOIP protocol for Linux bundles because WSP is the default protocol for those bundles.
  • User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.

func (*Client) DeleteAccountLinkInvitation added in v1.39.0 

func (c *Client) DeleteAccountLinkInvitation(ctx context.Context, params *DeleteAccountLinkInvitationInput, optFns ...func(*Options)) (*DeleteAccountLinkInvitationOutput, error)

Deletes the account link invitation.

func (*Client) DeleteClientBranding added in v1.17.0 

func (c *Client) DeleteClientBranding(ctx context.Context, params *DeleteClientBrandingInput, optFns ...func(*Options)) (*DeleteClientBrandingOutput, error)

Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you delete your customized client branding, your login portal reverts to the default client branding.

func (*Client) DeleteConnectClientAddIn added in v1.14.0 

func (c *Client) DeleteConnectClientAddIn(ctx context.Context, params *DeleteConnectClientAddInInput, optFns ...func(*Options)) (*DeleteConnectClientAddInOutput, error)

Deletes a client-add-in for Amazon Connect that is configured within a directory.

func (*Client) DeleteConnectionAlias added in v0.29.0 

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

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

func (c *Client) DeployWorkspaceApplications(ctx context.Context, params *DeployWorkspaceApplicationsInput, optFns ...func(*Options)) (*DeployWorkspaceApplicationsOutput, error)

Deploys associated applications to the specified WorkSpace

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 Directory Service pricing terms (http://aws.amazon.com/directoryservice/pricing/) . To delete empty directories, see Delete the Directory for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html) . If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

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

func (c *Client) DescribeApplicationAssociations(ctx context.Context, params *DescribeApplicationAssociationsInput, optFns ...func(*Options)) (*DescribeApplicationAssociationsOutput, error)

Describes the associations between the application and the specified associated resources.

func (*Client) DescribeApplications added in v1.31.0 

func (c *Client) DescribeApplications(ctx context.Context, params *DescribeApplicationsInput, optFns ...func(*Options)) (*DescribeApplicationsOutput, error)

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

func (*Client) DescribeBundleAssociations added in v1.31.0 

func (c *Client) DescribeBundleAssociations(ctx context.Context, params *DescribeBundleAssociationsInput, optFns ...func(*Options)) (*DescribeBundleAssociationsOutput, error)

Describes the associations between the applications and the specified bundle.

func (*Client) DescribeClientBranding added in v1.17.0 

func (c *Client) DescribeClientBranding(ctx context.Context, params *DescribeClientBrandingInput, optFns ...func(*Options)) (*DescribeClientBrandingOutput, error)

Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. Only device types that have branding information configured will be shown in the response.

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) DescribeConnectClientAddIns added in v1.14.0 

func (c *Client) DescribeConnectClientAddIns(ctx context.Context, params *DescribeConnectClientAddInsInput, optFns ...func(*Options)) (*DescribeConnectClientAddInsOutput, error)

Retrieves a list of Amazon Connect client add-ins that have been created.

func (*Client) DescribeConnectionAliasPermissions added in v0.29.0 

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 Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html) .

func (*Client) DescribeConnectionAliases added in v0.29.0 

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

func (c *Client) DescribeImageAssociations(ctx context.Context, params *DescribeImageAssociationsInput, optFns ...func(*Options)) (*DescribeImageAssociationsOutput, error)

Describes the associations between the applications and the specified image.

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

func (c *Client) DescribeWorkspaceAssociations(ctx context.Context, params *DescribeWorkspaceAssociationsInput, optFns ...func(*Options)) (*DescribeWorkspaceAssociationsOutput, error)

Describes the associations betweens applications and the specified WorkSpace.

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 Amazon Web Services 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 added in v0.29.0 

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

func (c *Client) DisassociateWorkspaceApplication(ctx context.Context, params *DisassociateWorkspaceApplicationInput, optFns ...func(*Options)) (*DisassociateWorkspaceApplicationOutput, error)

Disassociates the specified application from a WorkSpace. 

func (c *Client) GetAccountLink(ctx context.Context, params *GetAccountLinkInput, optFns ...func(*Options)) (*GetAccountLinkOutput, error)

Retrieves account link information.

func (*Client) ImportClientBranding added in v1.17.0 

func (c *Client) ImportClientBranding(ctx context.Context, params *ImportClientBrandingInput, optFns ...func(*Options)) (*ImportClientBrandingOutput, error)

Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in. After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience

  • You must specify at least one platform type when importing client branding.
  • You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
  • In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.
  • Imported data can take up to a minute to appear in the WorkSpaces client.

func (*Client) ImportWorkspaceImage 

func (c *Client) ImportWorkspaceImage(ctx context.Context, params *ImportWorkspaceImageInput, optFns ...func(*Options)) (*ImportWorkspaceImageOutput, error)

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html) . 

func (c *Client) ListAccountLinks(ctx context.Context, params *ListAccountLinksInput, optFns ...func(*Options)) (*ListAccountLinksOutput, error)

Lists all account links.

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 Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error. The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

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%\ 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) ModifyCertificateBasedAuthProperties added in v1.26.0 

func (c *Client) ModifyCertificateBasedAuthProperties(ctx context.Context, params *ModifyCertificateBasedAuthPropertiesInput, optFns ...func(*Options)) (*ModifyCertificateBasedAuthPropertiesOutput, error)

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

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

func (c *Client) ModifySamlProperties(ctx context.Context, params *ModifySamlPropertiesInput, optFns ...func(*Options)) (*ModifySamlPropertiesOutput, error)

Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

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) . The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/) .

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) Options added in v1.35.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

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 , UNHEALTHY , or REBOOTING . Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been stuck in the REBOOTING state for over 20 minutes. This operation is asynchronous and returns before the WorkSpaces have rebooted.

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) RejectAccountLinkInvitation added in v1.39.0 

func (c *Client) RejectAccountLinkInvitation(ctx context.Context, params *RejectAccountLinkInvitationInput, optFns ...func(*Options)) (*RejectAccountLinkInvitationOutput, error)

Rejects the account link invitation.

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 Support before terminating the WorkSpace. You can terminate a WorkSpace that is in any state except SUSPENDED . This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html) . If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated. Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms (http://aws.amazon.com/directoryservice/pricing/) . To delete empty directories, see Delete the Directory for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html) . If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

func (*Client) UpdateConnectClientAddIn added in v1.14.0 

func (c *Client) UpdateConnectClientAddIn(ctx context.Context, params *UpdateConnectClientAddInInput, optFns ...func(*Options)) (*UpdateConnectClientAddInOutput, error)

Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.

func (*Client) UpdateConnectionAliasPermission added in v0.29.0 

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

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 Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account. After an image has been shared, the recipient account can copy the image to other Regions as needed. In the China (Ningxia) Region, you can copy images only within the same Region. In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html) .

  • To delete an image that has been shared, you must unshare the image before you delete it.
  • Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.

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

type CopyWorkspaceImageOutput 

type CopyWorkspaceImageOutput struct {

	// The identifier of the image.
	ImageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAccountLinkInvitationInput added in v1.39.0 

type CreateAccountLinkInvitationInput struct {

	// The identifier of the target account.
	//
	// This member is required.
	TargetAccountId *string

	// A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent
	// creation.
	ClientToken *string
	// contains filtered or unexported fields
}

type CreateAccountLinkInvitationOutput added in v1.39.0 

type CreateAccountLinkInvitationOutput struct {

	// Information about the account link.
	AccountLink *types.AccountLink

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateConnectClientAddInInput added in v1.14.0 

type CreateConnectClientAddInInput struct {

	// The name of the client add-in.
	//
	// This member is required.
	Name *string

	// The directory identifier for which to configure the client add-in.
	//
	// This member is required.
	ResourceId *string

	// The endpoint URL of the Amazon Connect client add-in.
	//
	// This member is required.
	URL *string
	// contains filtered or unexported fields
}

type CreateConnectClientAddInOutput added in v1.14.0 

type CreateConnectClientAddInOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateConnectionAliasInput added in v0.29.0 

type CreateConnectionAliasInput struct {

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

	// The tags to associate with the connection alias.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateConnectionAliasOutput added in v0.29.0 

type CreateConnectionAliasOutput struct {

	// The identifier of the connection alias.
	AliasId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type CreateIpGroupOutput 

type CreateIpGroupOutput struct {

	// The identifier of the group.
	GroupId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateStandbyWorkspacesInput added in v1.27.0 

type CreateStandbyWorkspacesInput struct {

	// The Region of the primary WorkSpace.
	//
	// This member is required.
	PrimaryRegion *string

	// Information about the standby WorkSpace to be created.
	//
	// This member is required.
	StandbyWorkspaces []types.StandbyWorkspace
	// contains filtered or unexported fields
}

type CreateStandbyWorkspacesOutput added in v1.27.0 

type CreateStandbyWorkspacesOutput struct {

	// Information about the standby WorkSpace that could not be created.
	FailedStandbyRequests []types.FailedCreateStandbyWorkspacesRequest

	// Information about the standby WorkSpace that was created.
	PendingStandbyRequests []types.PendingCreateStandbyWorkspacesRequest

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type CreateTagsOutput 

type CreateTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateUpdatedWorkspaceImageInput added in v1.7.0 

type CreateUpdatedWorkspaceImageInput struct {

	// A description of whether updates for the WorkSpace image are available.
	//
	// This member is required.
	Description *string

	// The name of the new updated WorkSpace image.
	//
	// This member is required.
	Name *string

	// The identifier of the source WorkSpace image.
	//
	// This member is required.
	SourceImageId *string

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

type CreateUpdatedWorkspaceImageOutput added in v1.7.0 

type CreateUpdatedWorkspaceImageOutput struct {

	// The identifier of the new updated WorkSpace image.
	ImageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkspaceBundleInput added in v1.2.0 

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 when you're
	// creating the bundle, you must create an IAM policy that grants your IAM user
	// permissions to use workspaces:CreateTags .
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateWorkspaceBundleOutput added in v1.2.0 

type CreateWorkspaceBundleOutput struct {

	// Describes a WorkSpace bundle.
	WorkspaceBundle *types.WorkspaceBundle

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkspaceImageInput added in v1.21.0 

type CreateWorkspaceImageInput struct {

	// The description of the new WorkSpace image.
	//
	// This member is required.
	Description *string

	// The name of the new WorkSpace image.
	//
	// This member is required.
	Name *string

	// The identifier of the source WorkSpace
	//
	// This member is required.
	WorkspaceId *string

	// The tags that you want to add to the new WorkSpace image. To add tags when
	// you're creating the image, you must create an IAM policy that grants your IAM
	// user permission to use workspaces:CreateTags .
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateWorkspaceImageOutput added in v1.21.0 

type CreateWorkspaceImageOutput struct {

	// The date when the image was created.
	Created *time.Time

	// The description of the image.
	Description *string

	// The identifier of the new WorkSpace image.
	ImageId *string

	// The name of the image.
	Name *string

	// The operating system that the image is running.
	OperatingSystem *types.OperatingSystem

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

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

	// The availability status of the image.
	State types.WorkspaceImageState

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkspacesInput 

type CreateWorkspacesInput struct {

	// The WorkSpaces to create. You can specify up to 25 WorkSpaces.
	//
	// This member is required.
	Workspaces []types.WorkspaceRequest
	// contains filtered or unexported fields
}

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

type DeleteAccountLinkInvitationInput added in v1.39.0 

type DeleteAccountLinkInvitationInput struct {

	// The identifier of the account link.
	//
	// This member is required.
	LinkId *string

	// A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent
	// creation.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteAccountLinkInvitationOutput added in v1.39.0 

type DeleteAccountLinkInvitationOutput struct {

	// Information about the account link.
	AccountLink *types.AccountLink

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteClientBrandingInput added in v1.17.0 

type DeleteClientBrandingInput struct {

	// The device type for which you want to delete client branding.
	//
	// This member is required.
	Platforms []types.ClientDeviceType

	// The directory identifier of the WorkSpace for which you want to delete client
	// branding.
	//
	// This member is required.
	ResourceId *string
	// contains filtered or unexported fields
}

type DeleteClientBrandingOutput added in v1.17.0 

type DeleteClientBrandingOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteConnectClientAddInInput added in v1.14.0 

type DeleteConnectClientAddInInput struct {

	// The identifier of the client add-in to delete.
	//
	// This member is required.
	AddInId *string

	// The directory identifier for which the client add-in is configured.
	//
	// This member is required.
	ResourceId *string
	// contains filtered or unexported fields
}

type DeleteConnectClientAddInOutput added in v1.14.0 

type DeleteConnectClientAddInOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteConnectionAliasInput added in v0.29.0 

type DeleteConnectionAliasInput struct {

	// The identifier of the connection alias to delete.
	//
	// This member is required.
	AliasId *string
	// contains filtered or unexported fields
}

type DeleteConnectionAliasOutput added in v0.29.0 

type DeleteConnectionAliasOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteIpGroupInput 

type DeleteIpGroupInput struct {

	// The identifier of the IP access control group.
	//
	// This member is required.
	GroupId *string
	// contains filtered or unexported fields
}

type DeleteIpGroupOutput 

type DeleteIpGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeleteTagsOutput 

type DeleteTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWorkspaceBundleInput added in v1.2.0 

type DeleteWorkspaceBundleInput struct {

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

type DeleteWorkspaceBundleOutput added in v1.2.0 

type DeleteWorkspaceBundleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteWorkspaceImageInput 

type DeleteWorkspaceImageInput struct {

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

type DeleteWorkspaceImageOutput 

type DeleteWorkspaceImageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeployWorkspaceApplicationsInput added in v1.31.0 

type DeployWorkspaceApplicationsInput struct {

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

	// Indicates whether the force flag is applied for the specified WorkSpace. When
	// the force flag is enabled, it allows previously failed deployments to be
	// retried.
	Force *bool
	// contains filtered or unexported fields
}

type DeployWorkspaceApplicationsOutput added in v1.31.0 

type DeployWorkspaceApplicationsOutput struct {

	// The list of deployed associations and information about them.
	Deployment *types.WorkSpaceApplicationDeployment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeregisterWorkspaceDirectoryOutput 

type DeregisterWorkspaceDirectoryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAccountInput 

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

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

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

type DescribeAccountOutput 

type DescribeAccountOutput struct {

	// The type of linked account.
	DedicatedTenancyAccountType types.DedicatedTenancyAccountType

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

type DescribeApplicationAssociationsAPIClient added in v1.31.0 

type DescribeApplicationAssociationsAPIClient interface {
	DescribeApplicationAssociations(context.Context, *DescribeApplicationAssociationsInput, ...func(*Options)) (*DescribeApplicationAssociationsOutput, error)
}

DescribeApplicationAssociationsAPIClient is a client that implements the DescribeApplicationAssociations operation.

type DescribeApplicationAssociationsInput added in v1.31.0 

type DescribeApplicationAssociationsInput struct {

	// The identifier of the specified application.
	//
	// This member is required.
	ApplicationId *string

	// The resource type of the associated resources.
	//
	// This member is required.
	AssociatedResourceTypes []types.ApplicationAssociatedResourceType

	// The maximum number of associations 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
	// contains filtered or unexported fields
}

type DescribeApplicationAssociationsOutput added in v1.31.0 

type DescribeApplicationAssociationsOutput struct {

	// List of associations and information about them.
	Associations []types.ApplicationResourceAssociation

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeApplicationAssociationsPaginator added in v1.31.0 

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

DescribeApplicationAssociationsPaginator is a paginator for DescribeApplicationAssociations

func NewDescribeApplicationAssociationsPaginator added in v1.31.0 

func NewDescribeApplicationAssociationsPaginator(client DescribeApplicationAssociationsAPIClient, params *DescribeApplicationAssociationsInput, optFns ...func(*DescribeApplicationAssociationsPaginatorOptions)) *DescribeApplicationAssociationsPaginator

NewDescribeApplicationAssociationsPaginator returns a new DescribeApplicationAssociationsPaginator

func (*DescribeApplicationAssociationsPaginator) HasMorePages added in v1.31.0 

func (p *DescribeApplicationAssociationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeApplicationAssociationsPaginator) NextPage added in v1.31.0 

func (p *DescribeApplicationAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeApplicationAssociationsOutput, error)

NextPage retrieves the next DescribeApplicationAssociations page.

type DescribeApplicationAssociationsPaginatorOptions added in v1.31.0 

type DescribeApplicationAssociationsPaginatorOptions struct {
	// The maximum number of associations 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
}

DescribeApplicationAssociationsPaginatorOptions is the paginator options for DescribeApplicationAssociations

type DescribeApplicationsAPIClient added in v1.31.0 

type DescribeApplicationsAPIClient interface {
	DescribeApplications(context.Context, *DescribeApplicationsInput, ...func(*Options)) (*DescribeApplicationsOutput, error)
}

DescribeApplicationsAPIClient is a client that implements the DescribeApplications operation.

type DescribeApplicationsInput added in v1.31.0 

type DescribeApplicationsInput struct {

	// The identifiers of one or more applications.
	ApplicationIds []string

	// The compute types supported by the applications.
	ComputeTypeNames []types.Compute

	// The license availability for the applications.
	LicenseType types.WorkSpaceApplicationLicenseType

	// The maximum number of applications 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

	// The operating systems supported by the applications.
	OperatingSystemNames []types.OperatingSystemName

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

type DescribeApplicationsOutput added in v1.31.0 

type DescribeApplicationsOutput struct {

	// List of information about the specified applications.
	Applications []types.WorkSpaceApplication

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeApplicationsPaginator added in v1.31.0 

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

DescribeApplicationsPaginator is a paginator for DescribeApplications

func NewDescribeApplicationsPaginator added in v1.31.0 

func NewDescribeApplicationsPaginator(client DescribeApplicationsAPIClient, params *DescribeApplicationsInput, optFns ...func(*DescribeApplicationsPaginatorOptions)) *DescribeApplicationsPaginator

NewDescribeApplicationsPaginator returns a new DescribeApplicationsPaginator

func (*DescribeApplicationsPaginator) HasMorePages added in v1.31.0 

func (p *DescribeApplicationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeApplicationsPaginator) NextPage added in v1.31.0 

func (p *DescribeApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeApplicationsOutput, error)

NextPage retrieves the next DescribeApplications page.

type DescribeApplicationsPaginatorOptions added in v1.31.0 

type DescribeApplicationsPaginatorOptions struct {
	// The maximum number of applications 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
}

DescribeApplicationsPaginatorOptions is the paginator options for DescribeApplications

type DescribeBundleAssociationsInput added in v1.31.0 

type DescribeBundleAssociationsInput struct {

	// The resource types of the associated resource.
	//
	// This member is required.
	AssociatedResourceTypes []types.BundleAssociatedResourceType

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

type DescribeBundleAssociationsOutput added in v1.31.0 

type DescribeBundleAssociationsOutput struct {

	// List of information about the specified associations.
	Associations []types.BundleResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeClientBrandingInput added in v1.17.0 

type DescribeClientBrandingInput struct {

	// The directory identifier of the WorkSpace for which you want to view client
	// branding information.
	//
	// This member is required.
	ResourceId *string
	// contains filtered or unexported fields
}

type DescribeClientBrandingOutput added in v1.17.0 

type DescribeClientBrandingOutput struct {

	// The branding information for Android devices.
	DeviceTypeAndroid *types.DefaultClientBrandingAttributes

	// The branding information for iOS devices.
	DeviceTypeIos *types.IosClientBrandingAttributes

	// The branding information for Linux devices.
	DeviceTypeLinux *types.DefaultClientBrandingAttributes

	// The branding information for macOS devices.
	DeviceTypeOsx *types.DefaultClientBrandingAttributes

	// The branding information for Web access.
	DeviceTypeWeb *types.DefaultClientBrandingAttributes

	// The branding information for Windows devices.
	DeviceTypeWindows *types.DefaultClientBrandingAttributes

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeClientPropertiesInput 

type DescribeClientPropertiesInput struct {

	// The resource identifier, in the form of directory IDs.
	//
	// This member is required.
	ResourceIds []string
	// contains filtered or unexported fields
}

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

type DescribeConnectClientAddInsInput added in v1.14.0 

type DescribeConnectClientAddInsInput struct {

	// The directory identifier for which the client add-in is configured.
	//
	// This member is required.
	ResourceId *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
	// contains filtered or unexported fields
}

type DescribeConnectClientAddInsOutput added in v1.14.0 

type DescribeConnectClientAddInsOutput struct {

	// Information about client add-ins.
	AddIns []types.ConnectClientAddIn

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

type DescribeConnectionAliasPermissionsInput added in v0.29.0 

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

type DescribeConnectionAliasPermissionsOutput added in v0.29.0 

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

type DescribeConnectionAliasesInput added in v0.29.0 

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

type DescribeConnectionAliasesOutput added in v0.29.0 

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

type DescribeImageAssociationsInput added in v1.31.0 

type DescribeImageAssociationsInput struct {

	// The resource types of the associated resource.
	//
	// This member is required.
	AssociatedResourceTypes []types.ImageAssociatedResourceType

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

type DescribeImageAssociationsOutput added in v1.31.0 

type DescribeImageAssociationsOutput struct {

	// List of information about the specified associations.
	Associations []types.ImageResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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

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

type DescribeTagsOutput 

type DescribeTagsOutput struct {

	// The tags.
	TagList []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeWorkspaceAssociationsInput added in v1.31.0 

type DescribeWorkspaceAssociationsInput struct {

	// The resource types of the associated resources.
	//
	// This member is required.
	AssociatedResourceTypes []types.WorkSpaceAssociatedResourceType

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

type DescribeWorkspaceAssociationsOutput added in v1.31.0 

type DescribeWorkspaceAssociationsOutput struct {

	// List of information about the specified associations.
	Associations []types.WorkspaceResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeWorkspaceBundlesAPIClient added in v0.30.0 

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 Amazon Web Services, specify AMAZON
	// . To describe the bundles that belong to your account, don't specify a value.
	Owner *string
	// contains filtered or unexported fields
}

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

type DescribeWorkspaceBundlesPaginator added in v0.30.0 

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

DescribeWorkspaceBundlesPaginator is a paginator for DescribeWorkspaceBundles

func NewDescribeWorkspaceBundlesPaginator added in v0.30.0 

func NewDescribeWorkspaceBundlesPaginator(client DescribeWorkspaceBundlesAPIClient, params *DescribeWorkspaceBundlesInput, optFns ...func(*DescribeWorkspaceBundlesPaginatorOptions)) *DescribeWorkspaceBundlesPaginator

NewDescribeWorkspaceBundlesPaginator returns a new DescribeWorkspaceBundlesPaginator

func (*DescribeWorkspaceBundlesPaginator) HasMorePages added in v0.30.0 

func (p *DescribeWorkspaceBundlesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeWorkspaceBundlesPaginator) NextPage added in v0.30.0 

func (p *DescribeWorkspaceBundlesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspaceBundlesOutput, error)

NextPage retrieves the next DescribeWorkspaceBundles page.

type DescribeWorkspaceBundlesPaginatorOptions added in v0.30.0 

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 added in v0.30.0 

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

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

type DescribeWorkspaceDirectoriesPaginator added in v0.30.0 

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

DescribeWorkspaceDirectoriesPaginator is a paginator for DescribeWorkspaceDirectories

func NewDescribeWorkspaceDirectoriesPaginator added in v0.30.0 

func NewDescribeWorkspaceDirectoriesPaginator(client DescribeWorkspaceDirectoriesAPIClient, params *DescribeWorkspaceDirectoriesInput, optFns ...func(*DescribeWorkspaceDirectoriesPaginatorOptions)) *DescribeWorkspaceDirectoriesPaginator

NewDescribeWorkspaceDirectoriesPaginator returns a new DescribeWorkspaceDirectoriesPaginator

func (*DescribeWorkspaceDirectoriesPaginator) HasMorePages added in v0.30.0 

func (p *DescribeWorkspaceDirectoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeWorkspaceDirectoriesPaginator) NextPage added in v0.30.0 

func (p *DescribeWorkspaceDirectoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspaceDirectoriesOutput, error)

NextPage retrieves the next DescribeWorkspaceDirectories page.

type DescribeWorkspaceDirectoriesPaginatorOptions added in v0.30.0 

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

type DescribeWorkspaceImagePermissionsOutput 

type DescribeWorkspaceImagePermissionsOutput struct {

	// The identifier of the image.
	ImageId *string

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

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

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

type DescribeWorkspaceSnapshotsInput 

type DescribeWorkspaceSnapshotsInput struct {

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

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

type DescribeWorkspacesAPIClient added in v0.30.0 

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

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

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

	// The name of the user-decoupled WorkSpace.
	WorkspaceName *string
	// contains filtered or unexported fields
}

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

type DescribeWorkspacesPaginator added in v0.30.0 

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

DescribeWorkspacesPaginator is a paginator for DescribeWorkspaces

func NewDescribeWorkspacesPaginator added in v0.30.0 

func NewDescribeWorkspacesPaginator(client DescribeWorkspacesAPIClient, params *DescribeWorkspacesInput, optFns ...func(*DescribeWorkspacesPaginatorOptions)) *DescribeWorkspacesPaginator

NewDescribeWorkspacesPaginator returns a new DescribeWorkspacesPaginator

func (*DescribeWorkspacesPaginator) HasMorePages added in v0.30.0 

func (p *DescribeWorkspacesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*DescribeWorkspacesPaginator) NextPage added in v0.30.0 

func (p *DescribeWorkspacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeWorkspacesOutput, error)

NextPage retrieves the next DescribeWorkspaces page.

type DescribeWorkspacesPaginatorOptions added in v0.30.0 

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 added in v0.29.0 

type DisassociateConnectionAliasInput struct {

	// The identifier of the connection alias to disassociate.
	//
	// This member is required.
	AliasId *string
	// contains filtered or unexported fields
}

type DisassociateConnectionAliasOutput added in v0.29.0 

type DisassociateConnectionAliasOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DisassociateIpGroupsOutput 

type DisassociateIpGroupsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateWorkspaceApplicationInput added in v1.31.0 

type DisassociateWorkspaceApplicationInput struct {

	// The identifier of the application.
	//
	// This member is required.
	ApplicationId *string

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

type DisassociateWorkspaceApplicationOutput added in v1.31.0 

type DisassociateWorkspaceApplicationOutput struct {

	// Information about the targeted association.
	Association *types.WorkspaceResourceAssociation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.29.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.29.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.29.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

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 added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.29.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.29.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAccountLinkInput added in v1.39.0 

type GetAccountLinkInput struct {

	// The identifier of the account to link.
	LinkId *string

	// The identifier of the account link
	LinkedAccountId *string
	// contains filtered or unexported fields
}

type GetAccountLinkOutput added in v1.39.0 

type GetAccountLinkOutput struct {

	// The account link of the account link to retrieve.
	AccountLink *types.AccountLink

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

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

type ImportClientBrandingInput struct {

	// The directory identifier of the WorkSpace for which you want to import client
	// branding.
	//
	// This member is required.
	ResourceId *string

	// The branding information to import for Android devices.
	DeviceTypeAndroid *types.DefaultImportClientBrandingAttributes

	// The branding information to import for iOS devices.
	DeviceTypeIos *types.IosImportClientBrandingAttributes

	// The branding information to import for Linux devices.
	DeviceTypeLinux *types.DefaultImportClientBrandingAttributes

	// The branding information to import for macOS devices.
	DeviceTypeOsx *types.DefaultImportClientBrandingAttributes

	// The branding information to import for web access.
	DeviceTypeWeb *types.DefaultImportClientBrandingAttributes

	// The branding information to import for Windows devices.
	DeviceTypeWindows *types.DefaultImportClientBrandingAttributes
	// contains filtered or unexported fields
}

type ImportClientBrandingOutput added in v1.17.0 

type ImportClientBrandingOutput struct {

	// The branding information configured for Android devices.
	DeviceTypeAndroid *types.DefaultClientBrandingAttributes

	// The branding information configured for iOS devices.
	DeviceTypeIos *types.IosClientBrandingAttributes

	// The branding information configured for Linux devices.
	DeviceTypeLinux *types.DefaultClientBrandingAttributes

	// The branding information configured for macOS devices.
	DeviceTypeOsx *types.DefaultClientBrandingAttributes

	// The branding information configured for web access.
	DeviceTypeWeb *types.DefaultClientBrandingAttributes

	// The branding information configured for Windows devices.
	DeviceTypeWindows *types.DefaultClientBrandingAttributes

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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, WorkSpaces
	// Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify
	// a value that ends in _WSP . To use PCoIP, specify a value that does not end in
	// _WSP . To use BYOP, specify a value that ends in _BYOP . For non-GPU-enabled
	// bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR ,
	// BYOL_REGULAR_WSP , or BYOL_REGULAR_BYOP , depending on the protocol. The
	// BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by
	// Amazon WorkSpaces Core. Contact your account team to be allow-listed to use
	// these values. For more information, see Amazon WorkSpaces Core (http://aws.amazon.com/workspaces/core/)
	// .
	//
	// This member is required.
	IngestionProcess types.WorkspaceImageIngestionProcess

	// If specified, the version of Microsoft Office to subscribe to. Valid only for
	// Windows 10 and 11 BYOL images. For more information about subscribing to Office
	// for BYOL images, see Bring Your Own Windows Desktop Licenses (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html)
	// .
	//   - Although this parameter is an array, only one item is allowed at this time.
	//   - Windows 11 only supports Microsoft_Office_2019 .
	Applications []types.Application

	// The tags. Each WorkSpaces resource can have a maximum of 50 tags.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type ImportWorkspaceImageOutput 

type ImportWorkspaceImageOutput struct {

	// The identifier of the WorkSpace image.
	ImageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAccountLinksAPIClient added in v1.39.0 

type ListAccountLinksAPIClient interface {
	ListAccountLinks(context.Context, *ListAccountLinksInput, ...func(*Options)) (*ListAccountLinksOutput, error)
}

ListAccountLinksAPIClient is a client that implements the ListAccountLinks operation.

type ListAccountLinksInput added in v1.39.0 

type ListAccountLinksInput struct {

	// Filters the account based on their link status.
	LinkStatusFilter []types.AccountLinkStatusEnum

	// The maximum number of accounts to return.
	MaxResults *int32

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

type ListAccountLinksOutput added in v1.39.0 

type ListAccountLinksOutput struct {

	// Information about the account links.
	AccountLinks []types.AccountLink

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

type ListAccountLinksPaginator added in v1.39.0 

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

ListAccountLinksPaginator is a paginator for ListAccountLinks

func NewListAccountLinksPaginator added in v1.39.0 

func NewListAccountLinksPaginator(client ListAccountLinksAPIClient, params *ListAccountLinksInput, optFns ...func(*ListAccountLinksPaginatorOptions)) *ListAccountLinksPaginator

NewListAccountLinksPaginator returns a new ListAccountLinksPaginator

func (*ListAccountLinksPaginator) HasMorePages added in v1.39.0 

func (p *ListAccountLinksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAccountLinksPaginator) NextPage added in v1.39.0 

func (p *ListAccountLinksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccountLinksOutput, error)

NextPage retrieves the next ListAccountLinks page.

type ListAccountLinksPaginatorOptions added in v1.39.0 

type ListAccountLinksPaginatorOptions struct {
	// The maximum number of accounts 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
}

ListAccountLinksPaginatorOptions is the paginator options for ListAccountLinks

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

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

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

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

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

type ModifyAccountOutput 

type ModifyAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ModifyCertificateBasedAuthPropertiesInput added in v1.26.0 

type ModifyCertificateBasedAuthPropertiesInput struct {

	// The resource identifiers, in the form of directory IDs.
	//
	// This member is required.
	ResourceId *string

	// The properties of the certificate-based authentication.
	CertificateBasedAuthProperties *types.CertificateBasedAuthProperties

	// The properties of the certificate-based authentication you want to delete.
	PropertiesToDelete []types.DeletableCertificateBasedAuthProperty
	// contains filtered or unexported fields
}

type ModifyCertificateBasedAuthPropertiesOutput added in v1.26.0 

type ModifyCertificateBasedAuthPropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ModifyClientPropertiesOutput 

type ModifyClientPropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ModifySamlPropertiesInput added in v1.22.0 

type ModifySamlPropertiesInput struct {

	// The directory identifier for which you want to configure SAML properties.
	//
	// This member is required.
	ResourceId *string

	// The SAML properties to delete as part of your request. Specify one of the
	// following options:
	//   - SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.
	//   - SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state
	//   parameter name.
	PropertiesToDelete []types.DeletableSamlProperty

	// The properties for configuring SAML 2.0 authentication.
	SamlProperties *types.SamlProperties
	// contains filtered or unexported fields
}

type ModifySamlPropertiesOutput added in v1.22.0 

type ModifySamlPropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ModifySelfservicePermissionsOutput 

type ModifySelfservicePermissionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ModifyWorkspaceAccessPropertiesOutput 

type ModifyWorkspaceAccessPropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ModifyWorkspaceCreationPropertiesOutput 

type ModifyWorkspaceCreationPropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ModifyWorkspacePropertiesInput 

type ModifyWorkspacePropertiesInput struct {

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

	// Indicates the data replication status.
	DataReplication types.DataReplication

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

type ModifyWorkspacePropertiesOutput 

type ModifyWorkspacePropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type ModifyWorkspaceStateOutput 

type ModifyWorkspaceStateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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 configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

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

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.33.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type RebootWorkspacesInput 

type RebootWorkspacesInput struct {

	// The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
	//
	// This member is required.
	RebootWorkspaceRequests []types.RebootRequest
	// contains filtered or unexported fields
}

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

type RebuildWorkspacesInput 

type RebuildWorkspacesInput struct {

	// The WorkSpace to rebuild. You can specify a single WorkSpace.
	//
	// This member is required.
	RebuildWorkspaceRequests []types.RebuildRequest
	// contains filtered or unexported fields
}

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

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
	// Amazon Web Services account must be enabled for BYOL. If your account has not
	// been enabled for BYOL, you will receive an InvalidParameterValuesException
	// error. For more information about BYOL images, see Bring Your Own Windows
	// Desktop Images (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html)
	// .
	Tenancy types.Tenancy
	// contains filtered or unexported fields
}

type RegisterWorkspaceDirectoryOutput 

type RegisterWorkspaceDirectoryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RejectAccountLinkInvitationInput added in v1.39.0 

type RejectAccountLinkInvitationInput struct {

	// The identifier of the account link
	//
	// This member is required.
	LinkId *string

	// The client token of the account link invitation to reject.
	ClientToken *string
	// contains filtered or unexported fields
}

type RejectAccountLinkInvitationOutput added in v1.39.0 

type RejectAccountLinkInvitationOutput struct {

	// Information about the account link.
	AccountLink *types.AccountLink

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type RestoreWorkspaceOutput 

type RestoreWorkspaceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type RevokeIpRulesOutput 

type RevokeIpRulesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartWorkspacesInput 

type StartWorkspacesInput struct {

	// The WorkSpaces to start. You can specify up to 25 WorkSpaces.
	//
	// This member is required.
	StartWorkspaceRequests []types.StartRequest
	// contains filtered or unexported fields
}

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

type StopWorkspacesInput 

type StopWorkspacesInput struct {

	// The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
	//
	// This member is required.
	StopWorkspaceRequests []types.StopRequest
	// contains filtered or unexported fields
}

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

type TerminateWorkspacesInput 

type TerminateWorkspacesInput struct {

	// The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
	//
	// This member is required.
	TerminateWorkspaceRequests []types.TerminateRequest
	// contains filtered or unexported fields
}

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

type UpdateConnectClientAddInInput added in v1.14.0 

type UpdateConnectClientAddInInput struct {

	// The identifier of the client add-in to update.
	//
	// This member is required.
	AddInId *string

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

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

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

type UpdateConnectClientAddInOutput added in v1.14.0 

type UpdateConnectClientAddInOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateConnectionAliasPermissionInput added in v0.29.0 

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
	// Amazon Web Services account.
	//
	// This member is required.
	ConnectionAliasPermission *types.ConnectionAliasPermission
	// contains filtered or unexported fields
}

type UpdateConnectionAliasPermissionOutput added in v0.29.0 

type UpdateConnectionAliasPermissionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type UpdateRulesOfIpGroupOutput 

type UpdateRulesOfIpGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWorkspaceBundleInput added in v1.2.0 

type UpdateWorkspaceBundleInput struct {

	// The identifier of the bundle.
	BundleId *string

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

type UpdateWorkspaceBundleOutput added in v1.2.0 

type UpdateWorkspaceBundleOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 Amazon Web Services account to share or unshare the image
	// with. Before sharing the image, confirm that you are sharing to the correct
	// Amazon Web Services account ID.
	//
	// This member is required.
	SharedAccountId *string
	// contains filtered or unexported fields
}

type UpdateWorkspaceImagePermissionOutput 

type UpdateWorkspaceImagePermissionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.