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/aws-sdk-go-v2/service/gamelift/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// This operation is used with the Amazon GameLift FleetIQ solution and game server
15// groups. Retrieves information on a game server group. This operation returns
16// only properties related to GameLift FleetIQ. To view or update properties for
17// the corresponding Auto Scaling group, such as launch template, auto scaling
18// policies, and maximum/minimum group size, access the Auto Scaling group
19// directly. To get attributes for a game server group, provide a group name or ARN
20// value. If successful, a GameServerGroup object is returned. Learn more GameLift
21// FleetIQ Guide
22// (https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html)
23// Related operations
24//
25// * CreateGameServerGroup
26//
27// * ListGameServerGroups
28//
29// *
30// DescribeGameServerGroup
31//
32// * UpdateGameServerGroup
33//
34// * DeleteGameServerGroup
35//
36// *
37// ResumeGameServerGroup
38//
39// * SuspendGameServerGroup
40//
41// * DescribeGameServerInstances
42func (c *Client) DescribeGameServerGroup(ctx context.Context, params *DescribeGameServerGroupInput, optFns ...func(*Options)) (*DescribeGameServerGroupOutput, error) {
43	if params == nil {
44		params = &DescribeGameServerGroupInput{}
45	}
46
47	result, metadata, err := c.invokeOperation(ctx, "DescribeGameServerGroup", params, optFns, addOperationDescribeGameServerGroupMiddlewares)
48	if err != nil {
49		return nil, err
50	}
51
52	out := result.(*DescribeGameServerGroupOutput)
53	out.ResultMetadata = metadata
54	return out, nil
55}
56
57type DescribeGameServerGroupInput struct {
58
59	// A unique identifier for the game server group. Use either the GameServerGroup
60	// name or ARN value.
61	//
62	// This member is required.
63	GameServerGroupName *string
64}
65
66type DescribeGameServerGroupOutput struct {
67
68	// An object with the property settings for the requested game server group
69	// resource.
70	GameServerGroup *types.GameServerGroup
71
72	// Metadata pertaining to the operation's result.
73	ResultMetadata middleware.Metadata
74}
75
76func addOperationDescribeGameServerGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
77	err = stack.Serialize.Add(&awsAwsjson11_serializeOpDescribeGameServerGroup{}, middleware.After)
78	if err != nil {
79		return err
80	}
81	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpDescribeGameServerGroup{}, middleware.After)
82	if err != nil {
83		return err
84	}
85	if err = addSetLoggerMiddleware(stack, options); err != nil {
86		return err
87	}
88	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
89		return err
90	}
91	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
92		return err
93	}
94	if err = addResolveEndpointMiddleware(stack, options); err != nil {
95		return err
96	}
97	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
98		return err
99	}
100	if err = addRetryMiddlewares(stack, options); err != nil {
101		return err
102	}
103	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
104		return err
105	}
106	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
107		return err
108	}
109	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
110		return err
111	}
112	if err = addClientUserAgent(stack); err != nil {
113		return err
114	}
115	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
116		return err
117	}
118	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
119		return err
120	}
121	if err = addOpDescribeGameServerGroupValidationMiddleware(stack); err != nil {
122		return err
123	}
124	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDescribeGameServerGroup(options.Region), middleware.Before); err != nil {
125		return err
126	}
127	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
128		return err
129	}
130	if err = addResponseErrorMiddleware(stack); err != nil {
131		return err
132	}
133	if err = addRequestResponseLogging(stack, options); err != nil {
134		return err
135	}
136	return nil
137}
138
139func newServiceMetadataMiddleware_opDescribeGameServerGroup(region string) *awsmiddleware.RegisterServiceMetadata {
140	return &awsmiddleware.RegisterServiceMetadata{
141		Region:        region,
142		ServiceID:     ServiceID,
143		SigningName:   "gamelift",
144		OperationName: "DescribeGameServerGroup",
145	}
146}
147