Amazon GameLift

This API works with the following fleet types: Container

Retrieves the port mappings for a container group running on a container fleet. Port mappings show how container ports are mapped to connection ports on the fleet instance. Use this operation to find the connection port for a specific container on a fleet instance.

Request options

• Get port mappings for a game server container group. Provide the fleet ID, set ContainerGroupType to GAME_SERVER, and specify the ComputeName for the game server container group.

• Get port mappings for a per-instance container group. Provide the fleet ID, set ContainerGroupType to PER_INSTANCE, and specify the InstanceId for the instance.

• Optionally filter results to a single container by providing a ContainerName.

Results

This operation returns the fleet ID, location, container group definition ARN, container group type, compute name (for game server container groups), instance ID, and a list of ContainerGroupPortMapping objects. Each object contains the container name, runtime ID, and a list of port mappings that show how container ports map to connection ports on the instance.

Learn more

Connect to containers

Create a container group definition

See also: AWS API Documentation

Request Syntax

client.describe_container_group_port_mappings(
    FleetId='string',
    ContainerGroupType='GAME_SERVER'|'PER_INSTANCE',
    ComputeName='string',
    InstanceId='string',
    ContainerName='string'
)

type FleetId:

string

param FleetId:

[REQUIRED]

A unique identifier for the container fleet. You can use either the fleet ID or ARN value.

type ContainerGroupType:

string

param ContainerGroupType:

[REQUIRED]

The type of container group to retrieve port mappings for.

• GAME_SERVER -- Get port mappings for a game server container group.

• PER_INSTANCE -- Get port mappings for a per-instance container group.

type ComputeName:

string

param ComputeName:

A unique identifier for the compute resource for which to retrieve port mappings. For a container fleet, a compute represents a game server container group running on a fleet instance. You can use either the compute name or ARN value.

When ContainerGroupType is GAME_SERVER, this parameter is required.

When ContainerGroupType is PER_INSTANCE, do not provide this parameter. If you provide a compute name with PER_INSTANCE, the request fails with an InvalidRequestException.

type InstanceId:

string

param InstanceId:

A unique identifier for the fleet instance to retrieve port mappings for.

When ContainerGroupType is PER_INSTANCE, this parameter is required.

When ContainerGroupType is GAME_SERVER, this parameter is optional. If you provide an instance ID, it must match the instance that's running the specified compute. If the instance ID doesn't match, the request fails with an InvalidRequestException.

type ContainerName:

string

param ContainerName:

A container name to filter the results. When provided, the operation returns port mappings for the specified container only. If no container with the specified name exists in the container group, the request fails with a NotFoundException.

If not provided, the operation returns port mappings for all containers in the container group.

rtype:

dict

returns:

Response Syntax

{
    'FleetId': 'string',
    'Location': 'string',
    'ContainerGroupDefinitionArn': 'string',
    'ContainerGroupType': 'GAME_SERVER'|'PER_INSTANCE',
    'ComputeName': 'string',
    'InstanceId': 'string',
    'ContainerGroupPortMappings': [
        {
            'ContainerName': 'string',
            'ContainerRuntimeId': 'string',
            'ContainerPortMappings': [
                {
                    'ContainerPort': 123,
                    'ConnectionPort': 123,
                    'Protocol': 'TCP'|'UDP'
                },
            ]
        },
    ]
}

Response Structure

• (dict) --

  • FleetId (string) --

    A unique identifier for the container fleet.

  • Location (string) --

    The location of the fleet instance, expressed as an Amazon Web Services Region code, such as us-west-2.

  • ContainerGroupDefinitionArn (string) --

    The Amazon Resource Name ( ARN) that is assigned to the container group definition. The ARN value also identifies the specific container group definition version in use.

  • ContainerGroupType (string) --

    The type of container group that was specified in the request. Valid values are GAME_SERVER or PER_INSTANCE.

  • ComputeName (string) --

    A unique identifier for the compute resource running the game server container group. Returned when ContainerGroupType is GAME_SERVER.

  • InstanceId (string) --

    A unique identifier for the fleet instance. For GAME_SERVER requests, this is the instance running the specified compute. For PER_INSTANCE requests, this is the instance specified in the request.

  • ContainerGroupPortMappings (list) --

    A list of ContainerGroupPortMapping objects that describe the port mappings for each container in the container group.

    • (dict) --

      Describes the port mappings for a single container in a container group. Each mapping shows how a container port maps to a connection port on the fleet instance.

      Returned by: DescribeContainerGroupPortMappings

      • ContainerName (string) --

        The name of the container, as defined in the container group definition.

      • ContainerRuntimeId (string) --

        The runtime ID for the container that's running in a compute. This value is unique within the compute.

      • ContainerPortMappings (list) --

        A list of ContainerPortMapping objects that describe the port mappings for this container.

        • (dict) --

          Describes a mapping between a container port and a connection port on a fleet instance. You define container ports in a container group definition. Amazon GameLift Servers assigns connection ports when it deploys the container group to an instance.

          Part of: ContainerGroupPortMapping

          • ContainerPort (integer) --

            The port number on the container. This port is defined in the container group definition. Container port numbers must be unique within a container group definition.

          • ConnectionPort (integer) --

            The port number on the fleet instance that maps to the container port. Connection ports are assigned by Amazon GameLift Servers when the container group is deployed to an instance.

          • Protocol (string) --

            The network protocol for the port mapping. Valid values are TCP or UDP.