workspaces

type AssociateIpGroupsInput struct {
	// The identifiers of one or more IP access control groups.
	GroupIds []*string
	// The identifier of the directory.
	DirectoryId *string
}

type AssociateIpGroupsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AuthorizeIpRulesInput struct {
	// The rules to add to the group.
	UserRules []*types.IpRuleItem
	// The identifier of the group.
	GroupId *string
}

type AuthorizeIpRulesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type CopyWorkspaceImageInput struct {
	// The name of the image.
	Name *string
	// The identifier of the source image.
	SourceImageId *string
	// The tags for the image.
	Tags []*types.Tag
	// The identifier of the source Region.
	SourceRegion *string
	// A description of the image.
	Description *string
}

type CopyWorkspaceImageOutput struct {
	// The identifier of the image.
	ImageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateIpGroupInput struct {
	// The rules to add to the group.
	UserRules []*types.IpRuleItem
	// The name of the group.
	GroupName *string
	// The tags. Each WorkSpaces resource can have a maximum of 50 tags.
	Tags []*types.Tag
	// The description of the group.
	GroupDesc *string
}

type CreateIpGroupOutput struct {
	// The identifier of the group.
	GroupId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateTagsInput struct {
	// The tags. Each WorkSpaces resource can have a maximum of 50 tags. If you want to
	// add new tags to a set of existing tags, you must submit all of the existing tags
	// along with the new ones.
	Tags []*types.Tag
	// The identifier of the WorkSpaces resource. The supported resource types are
	// WorkSpaces, registered directories, images, custom bundles, and IP access
	// control groups.
	ResourceId *string
}

type CreateTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateWorkspacesInput struct {
	// The WorkSpaces to create. You can specify up to 25 WorkSpaces.
	Workspaces []*types.WorkspaceRequest
}

type CreateWorkspacesOutput struct {
	// 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
	// Information about the WorkSpaces that could not be created.
	FailedRequests []*types.FailedCreateWorkspaceRequest

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteIpGroupInput struct {
	// The identifier of the IP access control group.
	GroupId *string
}

type DeleteIpGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteTagsInput struct {
	// The tag keys.
	TagKeys []*string
	// The identifier of the WorkSpaces resource. The supported resource types are
	// WorkSpaces, registered directories, images, custom bundles, and IP access
	// control groups.
	ResourceId *string
}

type DeleteTagsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteWorkspaceImageInput struct {
	// The identifier of the image.
	ImageId *string
}

type DeleteWorkspaceImageOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeregisterWorkspaceDirectoryInput struct {
	// The identifier of the directory. If any WorkSpaces are registered to this
	// directory, you must remove them before you deregister the directory, or you will
	// receive an OperationNotSupportedException error.
	DirectoryId *string
}

type DeregisterWorkspaceDirectoryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAccountInput struct {
}

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

type DescribeAccountModificationsOutput struct {
	// The list of modifications to the configuration of BYOL.
	AccountModifications []*types.AccountModification
	// The token to use to retrieve the next set of results, or null if no more results
	// are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeAccountOutput struct {
	// The IP address range, specified as an IPv4 CIDR block, used for the management
	// network interface. The management network interface is connected to a secure
	// Amazon WorkSpaces management network. It is used for interactive streaming of
	// the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon
	// WorkSpaces to manage the WorkSpace.
	DedicatedTenancyManagementCidrRange *string
	// The status of BYOL (whether BYOL is enabled or disabled).
	DedicatedTenancySupport types.DedicatedTenancySupportResultEnum

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeClientPropertiesInput struct {
	// The resource identifier, in the form of directory IDs.
	ResourceIds []*string
}

type DescribeClientPropertiesOutput struct {
	// Information about the specified Amazon WorkSpaces clients.
	ClientPropertiesList []*types.ClientPropertiesResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeIpGroupsInput struct {
	// The identifiers of one or more IP access control groups.
	GroupIds []*string
	// The maximum number of items to return.
	MaxResults *int32
	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string
}

type DescribeIpGroupsOutput struct {
	// The token to use to retrieve the next set of results, or null if no more results
	// are available.
	NextToken *string
	// Information about the IP access control groups.
	Result []*types.WorkspacesIpGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeTagsInput struct {
	// The identifier of the WorkSpaces resource. The supported resource types are
	// WorkSpaces, registered directories, images, custom bundles, and IP access
	// control groups.
	ResourceId *string
}

type DescribeTagsOutput struct {
	// The tags.
	TagList []*types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorkspaceBundlesInput struct {
	// The token for the next set of results. (You received this token from a previous
	// call.)
	NextToken *string
	// The identifiers of the bundles. You cannot combine this parameter with any other
	// filter.
	BundleIds []*string
	// The owner of the bundles. You cannot combine this parameter with any other
	// filter. Specify AMAZON to describe the bundles provided by AWS or null to
	// describe the bundles that belong to your account.
	Owner *string
}

type DescribeWorkspaceBundlesOutput struct {
	// Information about the bundles.
	Bundles []*types.WorkspaceBundle
	// The token to use to retrieve the next set of results, or null if there are no
	// more results available. This token is valid for one day and must be used within
	// that time frame.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorkspaceDirectoriesInput struct {
	// 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
	// The identifiers of the directories. If the value is null, all directories are
	// retrieved.
	DirectoryIds []*string
}

type DescribeWorkspaceDirectoriesOutput struct {
	// The token to use to retrieve the next set of results, or null if no more results
	// are available.
	NextToken *string
	// Information about the directories.
	Directories []*types.WorkspaceDirectory

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorkspaceImagePermissionsInput struct {
	// 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
	// The identifier of the image.
	ImageId *string
}

type DescribeWorkspaceImagePermissionsOutput struct {
	// The identifiers of the AWS accounts that the image has been shared with.
	ImagePermissions []*types.ImagePermission
	// The identifier of the image.
	ImageId *string
	// The token to use to retrieve the next set of results, or null if no more results
	// are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorkspaceImagesInput struct {
	// The identifier of the image.
	ImageIds []*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
	// The type (owned or shared) of the image.
	ImageType types.ImageType
}

type DescribeWorkspaceImagesOutput struct {
	// The token to use to retrieve the next set of results, or null if no more results
	// are available.
	NextToken *string
	// Information about the images.
	Images []*types.WorkspaceImage

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorkspaceSnapshotsInput struct {
	// The identifier of the WorkSpace.
	WorkspaceId *string
}

type DescribeWorkspaceSnapshotsOutput struct {
	// Information about the snapshots that can be used to rebuild a WorkSpace. These
	// snapshots include the user volume.
	RebuildSnapshots []*types.Snapshot
	// Information about the snapshots that can be used to restore a WorkSpace. These
	// snapshots include both the root volume and the user volume.
	RestoreSnapshots []*types.Snapshot

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorkspacesConnectionStatusInput struct {
	// If you received a NextToken from a previous call that was paginated, provide
	// this token to receive the next set of results.
	NextToken *string
	// The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
	WorkspaceIds []*string
}

type DescribeWorkspacesConnectionStatusOutput struct {
	// Information about the connection status of the WorkSpace.
	WorkspacesConnectionStatus []*types.WorkspaceConnectionStatus
	// The token to use to retrieve the next set of results, or null if no more results
	// are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeWorkspacesInput 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 name of the directory user. You must specify this parameter with
	// DirectoryId.
	UserName *string
	// The maximum number of items to return.
	Limit *int32
	// 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 identifiers of the WorkSpaces. You cannot combine this parameter with any
	// other filter. Because the CreateWorkspaces () operation is asynchronous, the
	// identifier it returns is not immediately available. If you immediately call
	// DescribeWorkspaces () with this identifier, no information is returned.
	WorkspaceIds []*string
}

type DescribeWorkspacesOutput struct {
	// Information about the WorkSpaces. Because CreateWorkspaces () is an asynchronous
	// operation, some of the returned information could be incomplete.
	Workspaces []*types.Workspace
	// The token to use to retrieve the next set of results, or null if no more results
	// are available.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateIpGroupsInput struct {
	// The identifiers of one or more IP access control groups.
	GroupIds []*string
	// The identifier of the directory.
	DirectoryId *string
}

type DisassociateIpGroupsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

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

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ImportWorkspaceImageInput struct {
	// The identifier of the EC2 image.
	Ec2ImageId *string
	// The description of the WorkSpace image.
	ImageDescription *string
	// The tags. Each WorkSpaces resource can have a maximum of 50 tags.
	Tags []*types.Tag
	// The ingestion process to be used when importing the image.
	IngestionProcess types.WorkspaceImageIngestionProcess
	// The name of the WorkSpace image.
	ImageName *string
}

type ImportWorkspaceImageOutput struct {
	// The identifier of the WorkSpace image.
	ImageId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListAvailableManagementCidrRangesInput struct {
	// The IP address range to search. Specify an IP address range that is compatible
	// with your network and in CIDR notation (that is, specify the range as an IPv4
	// CIDR block).
	ManagementCidrRangeConstraint *string
	// 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 maximum number of items to return.
	MaxResults *int32
}

type ListAvailableManagementCidrRangesOutput struct {
	// The token to use to retrieve the next set of results, or null if no more results
	// are available.
	NextToken *string
	// The list of available IP address ranges, specified as IPv4 CIDR blocks.
	ManagementCidrRanges []*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type MigrateWorkspaceInput struct {
	// The identifier of the WorkSpace to migrate from.
	SourceWorkspaceId *string
	// The identifier of the target bundle type to migrate the WorkSpace to.
	BundleId *string
}

type MigrateWorkspaceOutput struct {
	// 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
	// The original identifier of the WorkSpace that is being migrated.
	SourceWorkspaceId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ModifyAccountInput struct {
	// The status of BYOL.
	DedicatedTenancySupport types.DedicatedTenancySupportEnum
	// The IP address range, specified as an IPv4 CIDR block, for the management
	// network interface. Specify an IP address range that is compatible with your
	// network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
	// The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be
	// specified as available by the ListAvailableManagementCidrRanges operation.
	DedicatedTenancyManagementCidrRange *string
}

type ModifyAccountOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ModifyClientPropertiesInput struct {
	// Information about the Amazon WorkSpaces client.
	ClientProperties *types.ClientProperties
	// The resource identifiers, in the form of directory IDs.
	ResourceId *string
}

type ModifyClientPropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ModifySelfservicePermissionsInput struct {
	// The permissions to enable or disable self-service capabilities.
	SelfservicePermissions *types.SelfservicePermissions
	// The identifier of the directory.
	ResourceId *string
}

type ModifySelfservicePermissionsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ModifyWorkspaceAccessPropertiesInput struct {
	// The identifier of the directory.
	ResourceId *string
	// The device types and operating systems to enable or disable for access.
	WorkspaceAccessProperties *types.WorkspaceAccessProperties
}

type ModifyWorkspaceAccessPropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ModifyWorkspaceCreationPropertiesInput struct {
	// The default properties for creating WorkSpaces.
	WorkspaceCreationProperties *types.WorkspaceCreationProperties
	// The identifier of the directory.
	ResourceId *string
}

type ModifyWorkspaceCreationPropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ModifyWorkspacePropertiesInput struct {
	// The identifier of the WorkSpace.
	WorkspaceId *string
	// The properties of the WorkSpace.
	WorkspaceProperties *types.WorkspaceProperties
}

type ModifyWorkspacePropertiesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ModifyWorkspaceStateInput struct {
	// The WorkSpace state.
	WorkspaceState types.TargetWorkspaceState
	// The identifier of the WorkSpace.
	WorkspaceId *string
}

type ModifyWorkspaceStateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

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

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

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

type RebootWorkspacesInput struct {
	// The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
	RebootWorkspaceRequests []*types.RebootRequest
}

type RebootWorkspacesOutput struct {
	// Information about the WorkSpaces that could not be rebooted.
	FailedRequests []*types.FailedWorkspaceChangeRequest

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RebuildWorkspacesInput struct {
	// The WorkSpace to rebuild. You can specify a single WorkSpace.
	RebuildWorkspaceRequests []*types.RebuildRequest
}

type RebuildWorkspacesOutput struct {
	// Information about the WorkSpace that could not be rebuilt.
	FailedRequests []*types.FailedWorkspaceChangeRequest

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RegisterWorkspaceDirectoryInput struct {
	// The tags associated with the directory.
	Tags []*types.Tag
	// Indicates whether your WorkSpace directory is dedicated or shared. To use Bring
	// Your Own License (BYOL) images, this value must be set to DEDICATED and your AWS
	// account must be enabled for BYOL. If your account has not been enabled for BYOL,
	// you will receive an InvalidParameterValuesException error. For more information
	// about BYOL images, see Bring Your Own Windows Desktop Images
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html).
	Tenancy types.Tenancy
	// The identifier of the directory. You cannot register a directory if it does not
	// have a status of Active. If the directory does not have a status of Active, you
	// will receive an InvalidResourceStateException error. If you have already
	// registered the maximum number of directories that you can register with Amazon
	// WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister
	// directories that you are not using for WorkSpaces, and try again.
	DirectoryId *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.
	EnableWorkDocs *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
	// Indicates whether self-service capabilities are enabled or disabled.
	EnableSelfService *bool
}

type RegisterWorkspaceDirectoryOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions = internalendpoints.Options

type RestoreWorkspaceInput struct {
	// The identifier of the WorkSpace.
	WorkspaceId *string
}

type RestoreWorkspaceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type RevokeIpRulesInput struct {
	// The identifier of the group.
	GroupId *string
	// The rules to remove from the group.
	UserRules []*string
}

type RevokeIpRulesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StartWorkspacesInput struct {
	// The WorkSpaces to start. You can specify up to 25 WorkSpaces.
	StartWorkspaceRequests []*types.StartRequest
}

type StartWorkspacesOutput struct {
	// Information about the WorkSpaces that could not be started.
	FailedRequests []*types.FailedWorkspaceChangeRequest

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopWorkspacesInput struct {
	// The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
	StopWorkspaceRequests []*types.StopRequest
}

type StopWorkspacesOutput struct {
	// Information about the WorkSpaces that could not be stopped.
	FailedRequests []*types.FailedWorkspaceChangeRequest

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type TerminateWorkspacesInput struct {
	// The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
	TerminateWorkspaceRequests []*types.TerminateRequest
}

type TerminateWorkspacesOutput struct {
	// Information about the WorkSpaces that could not be terminated.
	FailedRequests []*types.FailedWorkspaceChangeRequest

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateRulesOfIpGroupInput struct {
	// One or more rules.
	UserRules []*types.IpRuleItem
	// The identifier of the group.
	GroupId *string
}

type UpdateRulesOfIpGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateWorkspaceImagePermissionInput struct {
	// The permission to copy the image. This permission can be revoked only after an
	// image has been shared.
	AllowCopyImage *bool
	// The identifier of the AWS account to share or unshare the image with.
	SharedAccountId *string
	// The identifier of the image.
	ImageId *string
}

type UpdateWorkspaceImagePermissionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}