1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package gamelift
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"time"
)
// Requests an authentication token from Amazon GameLift for a compute resource in
// an Amazon GameLift Anywhere fleet or container fleet. Game servers that are
// running on the compute use this token to communicate with the Amazon GameLift
// service, such as when calling the Amazon GameLift server SDK action InitSDK() .
// Authentication tokens are valid for a limited time span, so you need to request
// a fresh token before the current token expires.
//
// Use this operation based on the fleet compute type:
//
// - For EC2 fleets, auth token retrieval and refresh is handled automatically.
// All game servers that are running on all fleet instances have access to a valid
// auth token.
//
// - For ANYWHERE and CONTAINER fleets, if you're using the Amazon GameLift
// Agent, auth token retrieval and refresh is handled automatically for any
// container or Anywhere compute where the Agent is running. If you're not using
// the Agent, create a mechanism to retrieve and refresh auth tokens for computes
// that are running game server processes.
//
// # Learn more
//
// [Create an Anywhere fleet]
//
// [Test your integration]
//
// [Server SDK reference guides]
// - (for version 5.x)
//
// [Test your integration]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html
// [Server SDK reference guides]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html
// [Create an Anywhere fleet]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html
func (c *Client) GetComputeAuthToken(ctx context.Context, params *GetComputeAuthTokenInput, optFns ...func(*Options)) (*GetComputeAuthTokenOutput, error) {
if params == nil {
params = &GetComputeAuthTokenInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetComputeAuthToken", params, optFns, c.addOperationGetComputeAuthTokenMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetComputeAuthTokenOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetComputeAuthTokenInput struct {
// The name of the compute resource you are requesting the authentication token
// for. For an Anywhere fleet compute, use the registered compute name. For an EC2
// fleet instance, use the instance ID. For a container fleet, use the compute name
// (for example,
// a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9 ) or the
// compute ARN.
//
// This member is required.
ComputeName *string
// A unique identifier for the fleet that the compute is registered to.
//
// This member is required.
FleetId *string
noSmithyDocumentSerde
}
type GetComputeAuthTokenOutput struct {
// A valid temporary authentication token.
AuthToken *string
// The Amazon Resource Name ([ARN] ) that is assigned to an Amazon GameLift compute
// resource and uniquely identifies it. ARNs are unique across all Regions. Format
// is arn:aws:gamelift:::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .
//
// [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
ComputeArn *string
// The name of the compute resource that the authentication token is issued to.
ComputeName *string
// The amount of time until the authentication token is no longer valid.
ExpirationTimestamp *time.Time
// The Amazon Resource Name ([ARN] ) that is assigned to a Amazon GameLift fleet
// resource and uniquely identifies it. ARNs are unique across all Regions. Format
// is arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 .
//
// [ARN]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
FleetArn *string
// A unique identifier for the fleet that the compute is registered to.
FleetId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetComputeAuthTokenMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpGetComputeAuthToken{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpGetComputeAuthToken{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "GetComputeAuthToken"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpGetComputeAuthTokenValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetComputeAuthToken(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetComputeAuthToken(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "GetComputeAuthToken",
}
}
|