Module Values.DescribeContainerGroupPortMappingsOutputSource

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

Sourcetype nonrec t = {
  1. fleetId : FleetId.t option;
    (*

    A unique identifier for the container fleet.

    *)
  2. location : LocationStringModel.t option;
    (*

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

    *)
  3. containerGroupDefinitionArn : ContainerGroupDefinitionArn.t option;
    (*

    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.

    *)
  4. containerGroupType : ContainerGroupType.t option;
    (*

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

    *)
  5. computeName : ComputeName.t option;
    (*

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

    *)
  6. instanceId : InstanceId.t option;
    (*

    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.

    *)
  7. containerGroupPortMappings : ContainerGroupPortMappingList.t option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServiceException of InternalServiceException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `LimitExceededException of LimitExceededException.t
  4. | `NotFoundException of NotFoundException.t
  5. | `UnauthorizedException of UnauthorizedException.t
  6. | `UnsupportedRegionException of UnsupportedRegionException.t
  7. | `Unknown_operation_error of string * string option
]
Sourceval make : ?fleetId:??? -> ?location:??? -> ?containerGroupDefinitionArn:??? -> ?containerGroupType:??? -> ?computeName:??? -> ?instanceId:??? -> ?containerGroupPortMappings:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidRequestException of InvalidRequestException.t | `LimitExceededException of LimitExceededException.t | `NotFoundException of NotFoundException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidRequestException of InvalidRequestException.t | `LimitExceededException of LimitExceededException.t | `NotFoundException of NotFoundException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `Integer of PortNumber.t ]) list ] list | `String of NonZeroAnd128MaxAsciiString.t ]) list ] list | `String of FleetId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t