1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package gamelift
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/smithy-go/middleware"
10	smithyhttp "github.com/aws/smithy-go/transport/http"
11)
12
13// This operation is used with the Amazon GameLift FleetIQ solution and game server
14// groups. Removes the game server from a game server group. As a result of this
15// operation, the deregistered game server can no longer be claimed and will not be
16// returned in a list of active game servers. To deregister a game server, specify
17// the game server group and game server ID. If successful, this operation emits a
18// CloudWatch event with termination timestamp and reason. Learn more GameLift
19// FleetIQ Guide
20// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)
21// Related operations
22//
23// * RegisterGameServer
24//
25// * ListGameServers
26//
27// *
28// ClaimGameServer
29//
30// * DescribeGameServer
31//
32// * UpdateGameServer
33//
34// *
35// DeregisterGameServer
36func (c *Client) DeregisterGameServer(ctx context.Context, params *DeregisterGameServerInput, optFns ...func(*Options)) (*DeregisterGameServerOutput, error) {
37	if params == nil {
38		params = &DeregisterGameServerInput{}
39	}
40
41	result, metadata, err := c.invokeOperation(ctx, "DeregisterGameServer", params, optFns, addOperationDeregisterGameServerMiddlewares)
42	if err != nil {
43		return nil, err
44	}
45
46	out := result.(*DeregisterGameServerOutput)
47	out.ResultMetadata = metadata
48	return out, nil
49}
50
51type DeregisterGameServerInput struct {
52
53	// A unique identifier for the game server group where the game server is running.
54	// Use either the GameServerGroup name or ARN value.
55	//
56	// This member is required.
57	GameServerGroupName *string
58
59	// A custom string that uniquely identifies the game server to deregister.
60	//
61	// This member is required.
62	GameServerId *string
63}
64
65type DeregisterGameServerOutput struct {
66	// Metadata pertaining to the operation's result.
67	ResultMetadata middleware.Metadata
68}
69
70func addOperationDeregisterGameServerMiddlewares(stack *middleware.Stack, options Options) (err error) {
71	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDeregisterGameServer{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDeregisterGameServer{}, middleware.After)
76	if err != nil {
77		return err
78	}
79	if err = addSetLoggerMiddleware(stack, options); err != nil {
80		return err
81	}
82	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
83		return err
84	}
85	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
86		return err
87	}
88	if err = addResolveEndpointMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
92		return err
93	}
94	if err = addRetryMiddlewares(stack, options); err != nil {
95		return err
96	}
97	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
104		return err
105	}
106	if err = addClientUserAgent(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
113		return err
114	}
115	if err = addOpDeregisterGameServerValidationMiddleware(stack); err != nil {
116		return err
117	}
118	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeregisterGameServer(options.Region), middleware.Before); err != nil {
119		return err
120	}
121	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addResponseErrorMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addRequestResponseLogging(stack, options); err != nil {
128		return err
129	}
130	return nil
131}
132
133func newServiceMetadataMiddleware_opDeregisterGameServer(region string) *awsmiddleware.RegisterServiceMetadata {
134	return &awsmiddleware.RegisterServiceMetadata{
135		Region:        region,
136		ServiceID:     ServiceID,
137		SigningName:   "gamelift",
138		OperationName: "DeregisterGameServer",
139	}
140}
141