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// Requests remote access to a fleet instance. Remote access is useful for
15// debugging, gathering benchmarking data, or observing activity in real time. To
16// remotely access an instance, you need credentials that match the operating
17// system of the instance. For a Windows instance, GameLift returns a user name and
18// password as strings for use with a Windows Remote Desktop client. For a Linux
19// instance, GameLift returns a user name and RSA private key, also as strings, for
20// use with an SSH client. The private key must be saved in the proper format to a
21// .pem file before using. If you're making this request using the AWS CLI, saving
22// the secret can be handled as part of the GetInstanceAccess request, as shown in
23// one of the examples for this operation. To request access to a specific
24// instance, specify the IDs of both the instance and the fleet it belongs to. You
25// can retrieve a fleet's instance IDs by calling DescribeInstances. If successful,
26// an InstanceAccess object is returned that contains the instance's IP address and
27// a set of credentials. Learn more Remotely Access Fleet Instances
28// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html)Debug
29// Fleet Issues
30// (https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html)
31// Related actions DescribeInstances | GetInstanceAccess |
32// DescribeEC2InstanceLimits | All APIs by task
33// (https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets)
34func (c *Client) GetInstanceAccess(ctx context.Context, params *GetInstanceAccessInput, optFns ...func(*Options)) (*GetInstanceAccessOutput, error) {
35	if params == nil {
36		params = &GetInstanceAccessInput{}
37	}
38
39	result, metadata, err := c.invokeOperation(ctx, "GetInstanceAccess", params, optFns, addOperationGetInstanceAccessMiddlewares)
40	if err != nil {
41		return nil, err
42	}
43
44	out := result.(*GetInstanceAccessOutput)
45	out.ResultMetadata = metadata
46	return out, nil
47}
48
49// Represents the input for a request operation.
50type GetInstanceAccessInput struct {
51
52	// A unique identifier for the fleet that contains the instance you want access to.
53	// You can use either the fleet ID or ARN value. The fleet can be in any of the
54	// following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status
55	// may be accessible for a short time before they are deleted.
56	//
57	// This member is required.
58	FleetId *string
59
60	// A unique identifier for the instance you want to get access to. You can access
61	// an instance in any status.
62	//
63	// This member is required.
64	InstanceId *string
65}
66
67// Represents the returned data in response to a request operation.
68type GetInstanceAccessOutput struct {
69
70	// The connection information for a fleet instance, including IP address and access
71	// credentials.
72	InstanceAccess *types.InstanceAccess
73
74	// Metadata pertaining to the operation's result.
75	ResultMetadata middleware.Metadata
76}
77
78func addOperationGetInstanceAccessMiddlewares(stack *middleware.Stack, options Options) (err error) {
79	err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetInstanceAccess{}, middleware.After)
80	if err != nil {
81		return err
82	}
83	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetInstanceAccess{}, middleware.After)
84	if err != nil {
85		return err
86	}
87	if err = addSetLoggerMiddleware(stack, options); err != nil {
88		return err
89	}
90	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
91		return err
92	}
93	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
94		return err
95	}
96	if err = addResolveEndpointMiddleware(stack, options); err != nil {
97		return err
98	}
99	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
100		return err
101	}
102	if err = addRetryMiddlewares(stack, options); err != nil {
103		return err
104	}
105	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
106		return err
107	}
108	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
109		return err
110	}
111	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
112		return err
113	}
114	if err = addClientUserAgent(stack); err != nil {
115		return err
116	}
117	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
118		return err
119	}
120	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
121		return err
122	}
123	if err = addOpGetInstanceAccessValidationMiddleware(stack); err != nil {
124		return err
125	}
126	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetInstanceAccess(options.Region), middleware.Before); err != nil {
127		return err
128	}
129	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
130		return err
131	}
132	if err = addResponseErrorMiddleware(stack); err != nil {
133		return err
134	}
135	if err = addRequestResponseLogging(stack, options); err != nil {
136		return err
137	}
138	return nil
139}
140
141func newServiceMetadataMiddleware_opGetInstanceAccess(region string) *awsmiddleware.RegisterServiceMetadata {
142	return &awsmiddleware.RegisterServiceMetadata{
143		Region:        region,
144		ServiceID:     ServiceID,
145		SigningName:   "gamelift",
146		OperationName: "GetInstanceAccess",
147	}
148}
149