api_op_GetInstanceAccessDetails.go raw
1 // Code generated by smithy-go-codegen DO NOT EDIT.
2
3 package lightsail
4
5 import (
6 "context"
7 "fmt"
8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9 "github.com/aws/aws-sdk-go-v2/service/lightsail/types"
10 "github.com/aws/smithy-go/middleware"
11 smithyhttp "github.com/aws/smithy-go/transport/http"
12 )
13
14 // Returns temporary SSH keys you can use to connect to a specific virtual private
15 // server, or instance.
16 //
17 // The get instance access details operation supports tag-based access control via
18 // resource tags applied to the resource identified by instance name . For more
19 // information, see the [Amazon Lightsail Developer Guide].
20 //
21 // [Amazon Lightsail Developer Guide]: https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags
22 func (c *Client) GetInstanceAccessDetails(ctx context.Context, params *GetInstanceAccessDetailsInput, optFns ...func(*Options)) (*GetInstanceAccessDetailsOutput, error) {
23 if params == nil {
24 params = &GetInstanceAccessDetailsInput{}
25 }
26
27 result, metadata, err := c.invokeOperation(ctx, "GetInstanceAccessDetails", params, optFns, c.addOperationGetInstanceAccessDetailsMiddlewares)
28 if err != nil {
29 return nil, err
30 }
31
32 out := result.(*GetInstanceAccessDetailsOutput)
33 out.ResultMetadata = metadata
34 return out, nil
35 }
36
37 type GetInstanceAccessDetailsInput struct {
38
39 // The name of the instance to access.
40 //
41 // This member is required.
42 InstanceName *string
43
44 // The protocol to use to connect to your instance. Defaults to ssh .
45 Protocol types.InstanceAccessProtocol
46
47 noSmithyDocumentSerde
48 }
49
50 type GetInstanceAccessDetailsOutput struct {
51
52 // An array of key-value pairs containing information about a get instance access
53 // request.
54 AccessDetails *types.InstanceAccessDetails
55
56 // Metadata pertaining to the operation's result.
57 ResultMetadata middleware.Metadata
58
59 noSmithyDocumentSerde
60 }
61
62 func (c *Client) addOperationGetInstanceAccessDetailsMiddlewares(stack *middleware.Stack, options Options) (err error) {
63 if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
64 return err
65 }
66 err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetInstanceAccessDetails{}, middleware.After)
67 if err != nil {
68 return err
69 }
70 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetInstanceAccessDetails{}, middleware.After)
71 if err != nil {
72 return err
73 }
74 if err := addProtocolFinalizerMiddlewares(stack, options, "GetInstanceAccessDetails"); err != nil {
75 return fmt.Errorf("add protocol finalizers: %v", err)
76 }
77
78 if err = addlegacyEndpointContextSetter(stack, options); err != nil {
79 return err
80 }
81 if err = addSetLoggerMiddleware(stack, options); err != nil {
82 return err
83 }
84 if err = addClientRequestID(stack); err != nil {
85 return err
86 }
87 if err = addComputeContentLength(stack); err != nil {
88 return err
89 }
90 if err = addResolveEndpointMiddleware(stack, options); err != nil {
91 return err
92 }
93 if err = addComputePayloadSHA256(stack); err != nil {
94 return err
95 }
96 if err = addRetry(stack, options); err != nil {
97 return err
98 }
99 if err = addRawResponseToMetadata(stack); err != nil {
100 return err
101 }
102 if err = addRecordResponseTiming(stack); err != nil {
103 return err
104 }
105 if err = addSpanRetryLoop(stack, options); err != nil {
106 return err
107 }
108 if err = addClientUserAgent(stack, options); err != nil {
109 return err
110 }
111 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
112 return err
113 }
114 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
115 return err
116 }
117 if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
118 return err
119 }
120 if err = addTimeOffsetBuild(stack, c); err != nil {
121 return err
122 }
123 if err = addUserAgentRetryMode(stack, options); err != nil {
124 return err
125 }
126 if err = addCredentialSource(stack, options); err != nil {
127 return err
128 }
129 if err = addOpGetInstanceAccessDetailsValidationMiddleware(stack); err != nil {
130 return err
131 }
132 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetInstanceAccessDetails(options.Region), middleware.Before); err != nil {
133 return err
134 }
135 if err = addRecursionDetection(stack); err != nil {
136 return err
137 }
138 if err = addRequestIDRetrieverMiddleware(stack); err != nil {
139 return err
140 }
141 if err = addResponseErrorMiddleware(stack); err != nil {
142 return err
143 }
144 if err = addRequestResponseLogging(stack, options); err != nil {
145 return err
146 }
147 if err = addDisableHTTPSMiddleware(stack, options); err != nil {
148 return err
149 }
150 if err = addInterceptBeforeRetryLoop(stack, options); err != nil {
151 return err
152 }
153 if err = addInterceptAttempt(stack, options); err != nil {
154 return err
155 }
156 if err = addInterceptors(stack, options); err != nil {
157 return err
158 }
159 return nil
160 }
161
162 func newServiceMetadataMiddleware_opGetInstanceAccessDetails(region string) *awsmiddleware.RegisterServiceMetadata {
163 return &awsmiddleware.RegisterServiceMetadata{
164 Region: region,
165 ServiceID: ServiceID,
166 OperationName: "GetInstanceAccessDetails",
167 }
168 }
169