describe_compute

GameLift.Client.describe_compute(**kwargs)

Retrieves properties for a compute resource. To request a compute resource specify the fleet ID and compute name. If successful, GameLift returns an object containing the build properties.

See also: AWS API Documentation

Request Syntax

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

Parameters

• FleetId (string) --

  [REQUIRED]

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

• ComputeName (string) --

  [REQUIRED]

  A descriptive label that is associated with the compute resource registered to your fleet.

Return type

dict

Returns

Response Syntax

{
    'Compute': {
        'FleetId': 'string',
        'FleetArn': 'string',
        'ComputeName': 'string',
        'ComputeArn': 'string',
        'IpAddress': 'string',
        'DnsName': 'string',
        'ComputeStatus': 'PENDING'|'ACTIVE'|'TERMINATING',
        'Location': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'OperatingSystem': 'WINDOWS_2012'|'AMAZON_LINUX'|'AMAZON_LINUX_2',
        'Type': 't2.micro'|'t2.small'|'t2.medium'|'t2.large'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.12xlarge'|'c5.18xlarge'|'c5.24xlarge'|'c5a.large'|'c5a.xlarge'|'c5a.2xlarge'|'c5a.4xlarge'|'c5a.8xlarge'|'c5a.12xlarge'|'c5a.16xlarge'|'c5a.24xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'r5.large'|'r5.xlarge'|'r5.2xlarge'|'r5.4xlarge'|'r5.8xlarge'|'r5.12xlarge'|'r5.16xlarge'|'r5.24xlarge'|'r5a.large'|'r5a.xlarge'|'r5a.2xlarge'|'r5a.4xlarge'|'r5a.8xlarge'|'r5a.12xlarge'|'r5a.16xlarge'|'r5a.24xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m5.large'|'m5.xlarge'|'m5.2xlarge'|'m5.4xlarge'|'m5.8xlarge'|'m5.12xlarge'|'m5.16xlarge'|'m5.24xlarge'|'m5a.large'|'m5a.xlarge'|'m5a.2xlarge'|'m5a.4xlarge'|'m5a.8xlarge'|'m5a.12xlarge'|'m5a.16xlarge'|'m5a.24xlarge'|'c5d.large'|'c5d.xlarge'|'c5d.2xlarge'|'c5d.4xlarge'|'c5d.9xlarge'|'c5d.12xlarge'|'c5d.18xlarge'|'c5d.24xlarge'|'c6a.large'|'c6a.xlarge'|'c6a.2xlarge'|'c6a.4xlarge'|'c6a.8xlarge'|'c6a.12xlarge'|'c6a.16xlarge'|'c6a.24xlarge'|'c6i.large'|'c6i.xlarge'|'c6i.2xlarge'|'c6i.4xlarge'|'c6i.8xlarge'|'c6i.12xlarge'|'c6i.16xlarge'|'c6i.24xlarge'|'r5d.large'|'r5d.xlarge'|'r5d.2xlarge'|'r5d.4xlarge'|'r5d.8xlarge'|'r5d.12xlarge'|'r5d.16xlarge'|'r5d.24xlarge',
        'GameLiftServiceSdkEndpoint': 'string'
    }
}

Response Structure

• (dict) --

  • Compute (dict) --

    The details of the compute resource you registered to the specified fleet.

    • FleetId (string) --

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

    • FleetArn (string) --

      The Amazon Resource Name (ARN) of the fleet that the compute is registered to.

    • ComputeName (string) --

      A descriptive label that is associated with the compute resource registered to your fleet.

    • ComputeArn (string) --

      The ARN that is assigned to the compute resource and uniquely identifies it. ARNs are unique across locations.

    • IpAddress (string) --

      The IP address of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

    • DnsName (string) --

      The DNS name of the compute resource. GameLift requires the DNS name or IP address to manage your compute resource.

    • ComputeStatus (string) --

      Current status of the compute. A compute must have an ACTIVE status to host game sessions.

    • Location (string) --

      The name of the custom location you added to the fleet that this compute resource resides in.

    • CreationTime (datetime) --

      A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

    • OperatingSystem (string) --

      The type of operating system on your compute resource.

    • Type (string) --

      Which compute type that the fleet uses. A fleet can use Anywhere compute resources owned by you or managed Amazon EC2 instances.

    • GameLiftServiceSdkEndpoint (string) --

      The endpoint connection details of the GameLift SDK endpoint that your game server connects to.

Exceptions

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