GameLift / Client / get_compute_access

get_compute_access

GameLift.Client.get_compute_access(**kwargs)

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.

Request options

To request access to a compute, specify the compute name and the fleet ID.

Results

If successful, this operation returns a set of temporary Amazon Web Services credentials, including a two-part access key and a session token.

• With a managed 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.

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. Use ListCompute to retrieve compute identifiers.

Return type:

dict

Returns:

Response Syntax

{
    'FleetId': 'string',
    'FleetArn': 'string',
    'ComputeName': 'string',
    'ComputeArn': 'string',
    'Credentials': {
        'AccessKeyId': 'string',
        'SecretAccessKey': 'string',
        'SessionToken': 'string'
    },
    'Target': 'string',
    'ContainerIdentifiers': [
        {
            'ContainerName': 'string',
            'ContainerRuntimeId': '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) –

    The instance ID where the compute resource is running.

  • ContainerIdentifiers (list) –

    For a managed container fleet, a list of containers on the compute. Use the container runtime ID with Docker commands to connect to a specific container.

    • (dict) –

      A unique identifier for a container in a compute on a managed container fleet instance. This information makes it possible to remotely connect to a specific container on a fleet instance.

      Related to: ContainerAttribute

      Use with: GetComputeAccess

      • ContainerName (string) –

        The identifier for a container that’s running in a compute.

      • ContainerRuntimeId (string) –

        The runtime ID for the container that’s running in a compute. This value is unique within the compute. It is returned as a ContainerAttribute value in a Compute object.

Exceptions

• GameLift.Client.exceptions.UnauthorizedException

• GameLift.Client.exceptions.InvalidRequestException

• GameLift.Client.exceptions.NotFoundException

• GameLift.Client.exceptions.InternalServiceException

• GameLift.Client.exceptions.UnsupportedRegionException