get_compute_access

GameLift.Client.get_compute_access(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_compute_access(
    FleetId='string',
    ComputeName='string'
)

Parameters

• FleetId (string) --

  [REQUIRED]

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

• ComputeName (string) --

  [REQUIRED]

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

Return type

dict

Returns

Response Syntax

{
    'FleetId': 'string',
    'FleetArn': 'string',
    'ComputeName': 'string',
    'ComputeArn': 'string',
    'Credentials': {
        'AccessKeyId': 'string',
        'SecretAccessKey': 'string',
        'SessionToken': 'string'
    }
}

Response Structure

• (dict) --

  • FleetId (string) --

    The fleet ID of compute resource.

  • FleetArn (string) --

    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 .

  • ComputeName (string) --

    The name of the compute resource you requested credentials for.

  • ComputeArn (string) --

    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 .

  • Credentials (dict) --

    The access credentials for the compute resource.

    • AccessKeyId (string) --

      Temporary key allowing access to the Amazon GameLift S3 account.

    • SecretAccessKey (string) --

      Temporary secret key allowing access to the Amazon GameLift S3 account.

    • SessionToken (string) --

      Token used to associate a specific build ID with the files uploaded using these credentials.

Exceptions

• GameLift.Client.exceptions.UnauthorizedException
• GameLift.Client.exceptions.InvalidRequestException
• GameLift.Client.exceptions.NotFoundException
• GameLift.Client.exceptions.InternalServiceException