Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.GetComputeAccess

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or observing activity in real time.

To remotely access an instance, you need credentials that match the operating system of the instance. For a Windows instance, GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the CLI, saving the secret can be handled as part of the GetInstanceAccess request, as shown in one of the examples for this operation.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Synopsis

data GetComputeAccess = GetComputeAccess' {
- fleetId :: Text
- computeName :: Text
}
newGetComputeAccess :: Text -> Text -> GetComputeAccess
getComputeAccess_fleetId :: Lens' GetComputeAccess Text
getComputeAccess_computeName :: Lens' GetComputeAccess Text
data GetComputeAccessResponse = GetComputeAccessResponse' {
- computeArn :: Maybe Text
- computeName :: Maybe Text
- credentials :: Maybe (Sensitive AwsCredentials)
- fleetArn :: Maybe Text
- fleetId :: Maybe Text
- httpStatus :: Int
}
newGetComputeAccessResponse :: Int -> GetComputeAccessResponse
getComputeAccessResponse_computeArn :: Lens' GetComputeAccessResponse (Maybe Text)
getComputeAccessResponse_computeName :: Lens' GetComputeAccessResponse (Maybe Text)
getComputeAccessResponse_credentials :: Lens' GetComputeAccessResponse (Maybe AwsCredentials)
getComputeAccessResponse_fleetArn :: Lens' GetComputeAccessResponse (Maybe Text)
getComputeAccessResponse_fleetId :: Lens' GetComputeAccessResponse (Maybe Text)
getComputeAccessResponse_httpStatus :: Lens' GetComputeAccessResponse Int

Creating a Request

data GetComputeAccess Source #

See: newGetComputeAccess smart constructor.

Constructors

GetComputeAccess'
Fields fleetId :: Text A unique identifier for the fleet that the compute resource is registered to. computeName :: Text The name of the compute resource you are requesting credentials for.

Instances

Instances details

ToJSON GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods toJSON :: GetComputeAccess -> Value # toEncoding :: GetComputeAccess -> Encoding # toJSONList :: [GetComputeAccess] -> Value # toEncodingList :: [GetComputeAccess] -> Encoding #
ToHeaders GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods toHeaders :: GetComputeAccess -> [Header] #
ToPath GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods toPath :: GetComputeAccess -> ByteString #
ToQuery GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods toQuery :: GetComputeAccess -> QueryString #
AWSRequest GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Associated Types type AWSResponse GetComputeAccess # Methods request :: (Service -> Service) -> GetComputeAccess -> Request GetComputeAccess # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetComputeAccess -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetComputeAccess))) #
Generic GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Associated Types type Rep GetComputeAccess :: Type -> Type # Methods from :: GetComputeAccess -> Rep GetComputeAccess x # to :: Rep GetComputeAccess x -> GetComputeAccess #
Read GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods readsPrec :: Int -> ReadS GetComputeAccess # readList :: ReadS [GetComputeAccess] # readPrec :: ReadPrec GetComputeAccess # readListPrec :: ReadPrec [GetComputeAccess] #
Show GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods showsPrec :: Int -> GetComputeAccess -> ShowS # show :: GetComputeAccess -> String # showList :: [GetComputeAccess] -> ShowS #
NFData GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods rnf :: GetComputeAccess -> () #
Eq GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods (==) :: GetComputeAccess -> GetComputeAccess -> Bool # (/=) :: GetComputeAccess -> GetComputeAccess -> Bool #
Hashable GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods hashWithSalt :: Int -> GetComputeAccess -> Int # hash :: GetComputeAccess -> Int #
type AWSResponse GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess type AWSResponse GetComputeAccess = GetComputeAccessResponse
type Rep GetComputeAccess Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess type Rep GetComputeAccess = D1 ('MetaData "GetComputeAccess" "Amazonka.GameLift.GetComputeAccess" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "GetComputeAccess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "computeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetComputeAccess Source #

Arguments

:: Text	`GetComputeAccess`
-> Text	`GetComputeAccess`
-> GetComputeAccess

Create a value of GetComputeAccess with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetComputeAccess, getComputeAccess_fleetId - A unique identifier for the fleet that the compute resource is registered to.

GetComputeAccess, getComputeAccess_computeName - The name of the compute resource you are requesting credentials for.

Request Lenses

getComputeAccess_fleetId :: Lens' GetComputeAccess Text Source #

A unique identifier for the fleet that the compute resource is registered to.

getComputeAccess_computeName :: Lens' GetComputeAccess Text Source #

The name of the compute resource you are requesting credentials for.

Destructuring the Response

data GetComputeAccessResponse Source #

See: newGetComputeAccessResponse smart constructor.

Constructors

GetComputeAccessResponse'

Fields

computeArn :: Maybe Text
The Amazon Resource Name (ARN) that is assigned to a GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
computeName :: Maybe Text
The name of the compute resource you requested credentials for.
credentials :: Maybe (Sensitive AwsCredentials)
The access credentials for the compute resource.
fleetArn :: Maybe Text
The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
fleetId :: Maybe Text
The fleet ID of compute resource.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetComputeAccessResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Associated Types type Rep GetComputeAccessResponse :: Type -> Type # Methods from :: GetComputeAccessResponse -> Rep GetComputeAccessResponse x # to :: Rep GetComputeAccessResponse x -> GetComputeAccessResponse #
Show GetComputeAccessResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods showsPrec :: Int -> GetComputeAccessResponse -> ShowS # show :: GetComputeAccessResponse -> String # showList :: [GetComputeAccessResponse] -> ShowS #
NFData GetComputeAccessResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods rnf :: GetComputeAccessResponse -> () #
Eq GetComputeAccessResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess Methods (==) :: GetComputeAccessResponse -> GetComputeAccessResponse -> Bool # (/=) :: GetComputeAccessResponse -> GetComputeAccessResponse -> Bool #
type Rep GetComputeAccessResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAccess type Rep GetComputeAccessResponse = D1 ('MetaData "GetComputeAccessResponse" "Amazonka.GameLift.GetComputeAccess" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "GetComputeAccessResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "computeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "computeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive AwsCredentials))))) :: (S1 ('MetaSel ('Just "fleetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetComputeAccessResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetComputeAccessResponse'`
-> GetComputeAccessResponse

Create a value of GetComputeAccessResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetComputeAccessResponse, getComputeAccessResponse_computeArn - The Amazon Resource Name (ARN) that is assigned to a GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

GetComputeAccess, getComputeAccessResponse_computeName - The name of the compute resource you requested credentials for.

GetComputeAccessResponse, getComputeAccessResponse_credentials - The access credentials for the compute resource.

GetComputeAccessResponse, getComputeAccessResponse_fleetArn - The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

GetComputeAccess, getComputeAccessResponse_fleetId - The fleet ID of compute resource.

$sel:httpStatus:GetComputeAccessResponse', getComputeAccessResponse_httpStatus - The response's http status code.

Response Lenses

getComputeAccessResponse_computeArn :: Lens' GetComputeAccessResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a GameLift compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

getComputeAccessResponse_computeName :: Lens' GetComputeAccessResponse (Maybe Text) Source #

The name of the compute resource you requested credentials for.

getComputeAccessResponse_credentials :: Lens' GetComputeAccessResponse (Maybe AwsCredentials) Source #

The access credentials for the compute resource.

getComputeAccessResponse_fleetArn :: Lens' GetComputeAccessResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

getComputeAccessResponse_fleetId :: Lens' GetComputeAccessResponse (Maybe Text) Source #

The fleet ID of compute resource.

getComputeAccessResponse_httpStatus :: Lens' GetComputeAccessResponse Int Source #

The response's http status code.