describe_game_server ¶

def describe_game_server(
    self,
    *,
    config_overrides: Optional[GameLiftClientConfig] = None,
    game_server_group_name: Optional[
        "capo_gamelift.types.game_server_group_name_or_arn.GameServerGroupNameOrArn"
    ] = None,
    game_server_id: Optional[
        "capo_gamelift.types.game_server_id.GameServerId"
    ] = None,
) -> "capo_gamelift.types.describe_game_server_output.DescribeGameServerOutput":
    """<p> <b>This API works with the following fleet types:</b> EC2 (FleetIQ)</p> <p>Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on. </p> <p>To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned. </p> <p> <b>Learn more</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift Servers FleetIQ Guide</a> </p>

    Args:
        game_server_group_name: <p>A unique identifier for the game server group where the game server is running.</p>
        game_server_id: <p>A custom string that uniquely identifies the game server information to be retrieved.</p>

    Raises:
        capo_gamelift.errors.internal_service_exception.InternalServiceException: <p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.</p>
        capo_gamelift.errors.invalid_request_exception.InvalidRequestException: <p>One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.</p>
        capo_gamelift.errors.not_found_exception.NotFoundException: <p>The requested resource was not found. The resource was either not created yet or deleted.</p>
        capo_gamelift.errors.unauthorized_exception.UnauthorizedException: <p>The client failed authentication. Clients should not retry such requests.</p>
        capo_gamelift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_gamelift.types.describe_game_server_input.DescribeGameServerInput]",
    ) -> OperationResponse[
        "capo_gamelift.types.describe_game_server_output.DescribeGameServerOutput"
    ]:
        import capo_gamelift._operations.game_lift.describe_game_server

        output, http_response = (
            capo_gamelift._operations.game_lift.describe_game_server.describe_game_server(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_gamelift.types.describe_game_server_output.DescribeGameServerOutput",
    ) -> dict[str, Any]:
        import capo_gamelift.types.describe_game_server_output

        return capo_gamelift.types.describe_game_server_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeGameServer", redact_output=_redact_output),
    )
    input_: capo_gamelift.types.describe_game_server_input.DescribeGameServerInput = {}
    if game_server_group_name is not None:
        input_["game_server_group_name"] = game_server_group_name
    if game_server_id is not None:
        input_["game_server_id"] = game_server_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output