1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package workspaces 4 5import ( 6 "context" 7 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" 8 "github.com/aws/aws-sdk-go-v2/aws/signer/v4" 9 "github.com/aws/aws-sdk-go-v2/service/workspaces/types" 10 "github.com/aws/smithy-go/middleware" 11 smithyhttp "github.com/aws/smithy-go/transport/http" 12) 13 14// Terminates the specified WorkSpaces. Terminating a WorkSpace is a permanent 15// action and cannot be undone. The user's data is destroyed. If you need to 16// archive any user data, contact AWS Support before terminating the WorkSpace. You 17// can terminate a WorkSpace that is in any state except SUSPENDED. This operation 18// is asynchronous and returns before the WorkSpaces have been completely 19// terminated. After a WorkSpace is terminated, the TERMINATED state is returned 20// only briefly before the WorkSpace directory metadata is cleaned up, so this 21// state is rarely returned. To confirm that a WorkSpace is terminated, check for 22// the WorkSpace ID by using DescribeWorkSpaces 23// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html). 24// If the WorkSpace ID isn't returned, then the WorkSpace has been successfully 25// terminated. Simple AD and AD Connector are made available to you free of charge 26// to use with WorkSpaces. If there are no WorkSpaces being used with your Simple 27// AD or AD Connector directory for 30 consecutive days, this directory will be 28// automatically deregistered for use with Amazon WorkSpaces, and you will be 29// charged for this directory as per the AWS Directory Services pricing terms 30// (http://aws.amazon.com/directoryservice/pricing/). To delete empty directories, 31// see Delete the Directory for Your WorkSpaces 32// (https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). 33// If you delete your Simple AD or AD Connector directory, you can always create a 34// new one when you want to start using WorkSpaces again. 35func (c *Client) TerminateWorkspaces(ctx context.Context, params *TerminateWorkspacesInput, optFns ...func(*Options)) (*TerminateWorkspacesOutput, error) { 36 if params == nil { 37 params = &TerminateWorkspacesInput{} 38 } 39 40 result, metadata, err := c.invokeOperation(ctx, "TerminateWorkspaces", params, optFns, addOperationTerminateWorkspacesMiddlewares) 41 if err != nil { 42 return nil, err 43 } 44 45 out := result.(*TerminateWorkspacesOutput) 46 out.ResultMetadata = metadata 47 return out, nil 48} 49 50type TerminateWorkspacesInput struct { 51 52 // The WorkSpaces to terminate. You can specify up to 25 WorkSpaces. 53 // 54 // This member is required. 55 TerminateWorkspaceRequests []types.TerminateRequest 56} 57 58type TerminateWorkspacesOutput struct { 59 60 // Information about the WorkSpaces that could not be terminated. 61 FailedRequests []types.FailedWorkspaceChangeRequest 62 63 // Metadata pertaining to the operation's result. 64 ResultMetadata middleware.Metadata 65} 66 67func addOperationTerminateWorkspacesMiddlewares(stack *middleware.Stack, options Options) (err error) { 68 err = stack.Serialize.Add(&awsAwsjson11_serializeOpTerminateWorkspaces{}, middleware.After) 69 if err != nil { 70 return err 71 } 72 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpTerminateWorkspaces{}, middleware.After) 73 if err != nil { 74 return err 75 } 76 if err = addSetLoggerMiddleware(stack, options); err != nil { 77 return err 78 } 79 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 80 return err 81 } 82 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 83 return err 84 } 85 if err = addResolveEndpointMiddleware(stack, options); err != nil { 86 return err 87 } 88 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 89 return err 90 } 91 if err = addRetryMiddlewares(stack, options); err != nil { 92 return err 93 } 94 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 95 return err 96 } 97 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 98 return err 99 } 100 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 101 return err 102 } 103 if err = addClientUserAgent(stack); err != nil { 104 return err 105 } 106 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 107 return err 108 } 109 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 110 return err 111 } 112 if err = addOpTerminateWorkspacesValidationMiddleware(stack); err != nil { 113 return err 114 } 115 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opTerminateWorkspaces(options.Region), middleware.Before); err != nil { 116 return err 117 } 118 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 119 return err 120 } 121 if err = addResponseErrorMiddleware(stack); err != nil { 122 return err 123 } 124 if err = addRequestResponseLogging(stack, options); err != nil { 125 return err 126 } 127 return nil 128} 129 130func newServiceMetadataMiddleware_opTerminateWorkspaces(region string) *awsmiddleware.RegisterServiceMetadata { 131 return &awsmiddleware.RegisterServiceMetadata{ 132 Region: region, 133 ServiceID: ServiceID, 134 SigningName: "workspaces", 135 OperationName: "TerminateWorkspaces", 136 } 137} 138