GameLift / Client / get_compute_access

get_compute_access#

GameLift.Client.get_compute_access(**kwargs)#

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed fleet. This operation is not used with Amazon GameLift Anywhere fleets

To request access, specify the compute name and the fleet ID. If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token.

EC2 fleets

With an EC2 fleet (where compute type is EC2), use these credentials with Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see Starting a session (CLI) in the Amazon EC2 Systems Manager User Guide.

Container fleets

With a container fleet (where compute type is CONTAINER), use these credentials and the target value with SSM to connect to the fleet instance where the container is running. After you’re connected to the instance, use Docker commands to interact with the container.

Learn more

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 holds the compute resource that you want to connect to. You can use either the fleet ID or ARN value.

  • ComputeName (string) –

    [REQUIRED]

    A unique identifier for the compute resource that you want to connect to. For an EC2 fleet compute, use the instance ID. For a container fleet, use the compute name (for example, a123b456c789012d3e4567f8a901b23c/1a234b56-7cd8-9e0f-a1b2-c34d567ef8a9) or the compute ARN.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • FleetId (string) –

      The ID of the fleet that holds the compute resource to be accessed.

    • FleetArn (string) –

      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:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

    • ComputeName (string) –

      The identifier of the compute resource to be accessed. This value might be either a compute name or an instance ID.

    • ComputeArn (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:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

    • Credentials (dict) –

      A set of temporary Amazon Web Services credentials for use when connecting to the compute resource with Amazon EC2 Systems Manager (SSM).

      • AccessKeyId (string) –

        The access key ID that identifies the temporary security credentials.

      • SecretAccessKey (string) –

        The secret access key that can be used to sign requests.

      • SessionToken (string) –

        The token that users must pass to the service API to use the temporary credentials.

    • Target (string) –

      (For container fleets only) The instance ID where the compute resource is running.

Exceptions

  • GameLift.Client.exceptions.UnauthorizedException

  • GameLift.Client.exceptions.InvalidRequestException

  • GameLift.Client.exceptions.NotFoundException

  • GameLift.Client.exceptions.InternalServiceException